ScavSetLib

ScavSetLib (ScavSettingsLib) — Official API Reference

ScavSetLib is an independent, highly optimized class library/API designed for BepInEx mod developers of Casualties Unknown. It allows mods to register custom settings (Dropdowns, Floats, Integers, or Booleans) directly inside the game's official menus (Video, Audio, Game, etc.) with native styling, native sliders, native toggle switches, and fully automatic loading, saving, and localization lookup overrides.

1. Core Technical Architecture

The library bypasses the need for every developer to write redundant Harmony patches on the game's settings template lists and Locale translations. Instead, it runs a single centralized patch system that dynamically polls custom setting definitions and resolves their visual naming at runtime.

System Workflow:

Mod Developers

└── (Call Register API) ──> SettingsManager

└──> Populates Definitions & Localizations

└──> Registry Maps

┌──────────────────────────────────────┼──────────────────────────────────────┐

▼                                      ▼                                      ▼

Settings. DefaultSettings Postfix      Settings. EnsureLoaded Postfix          Locale. GetString Prefix

(Hook Default Templates)              (Hook Live Settings)                  (Hook Localization)

│                                      │                                      │

▼                                      ▼                                      ▼

Instantiates Custom Settings          Instantiates / Syncs Settings          Overrides 'gameset' strings

│                                      │                                      │

└──────────────────────────────────────┼──────────────────────────────────────┘

Game's Native UI Renderer

2. API Structuring

2. 1 Supported Setting Types

• [] Dropdowns (SettingDropdown): Selection menus with clean option labels.[/]

  []Float Sliders (SettingFloat): Float values with customizable range (min/max) and string formatting (e.g. percentages, decimals).[/]

  []Integer Sliders (SettingInt): Integer step-based ranges (min/max).[/]

  []Toggle Switches (SettingBool): Standard true/false checkboxes.[/]

  2. 2 Base Setting Definition

  All setting types inherit from a base definition class that populates core fields such as internal name, category (Video, Audio, Game, Input, Language), and synchronizes values when modified elsewhere.

  public abstract class SettingDefinition

  public string Name { get; set; } = string. Empty;

  public Setting. SettingCategory Category { get; set; }

  public string CleanName { get; set; } = string. Empty;

  public abstract Setting CreateSettingInstance();

  public abstract void SyncValueFromSource(Setting setting);

  ---

  3. How to Use ScavSetLib in Your Mod

  Step 1: Declare the BepInEx Dependency

  Ensure BepInEx is aware that your mod depends on ScavSetLib so it loads in the correct order:

  public class YourPlugin : BaseUnityPlugin

  Step 2: Register Settings inside Awake()

  To inject custom settings, call the static ScavSetLib. SettingsManager registration methods during initialization.

  using ScavSetLib;

  private void Awake()

  // 1. Register a Dropdown setting inside the native VIDEO category

  SettingsManager. RegisterDropdown(

  name: "MyCustomMode",