TimbnConfig

Helpers for a mod's BepInEx config file. Call them on the main thread. Signatures are in the API reference.

Config Helpers

config.BindRange(section, key, defaultValue, description, min, max)

Binds a setting within a minimum and maximum range, which a config manager can show as a slider. It is ConfigFile.Bind with an acceptable range, in one line.

TimeSpeed = config.BindRange("Meditation", "TimeSpeed", 7f, "How many times faster time runs while you meditate.", 1f, 50f);

config.BindHidden(section, key, defaultValue, description)

Binds a setting that stays out of the in-game configuration manager, for a switch only a developer needs, such as turning on a debug log. It is still written to the config file and read like any other entry.

WriteDebugLog = config.BindHidden("Debug", "WriteDebugLog", false, "Writes the debug log.");

TimbnConfig.CarryOver(config, (entry, oldSection, oldKey), ...)

Moves the value of a renamed or moved config entry into the new one, so players keep their settings. Call it at the end of BindConfig, once every new entry is bound. An old entry is only migrated if it is still present in the file, and it is removed from the file afterward.

TimbnConfig.CarryOver(
    config,
    (StuckCarriers, "Carriers", "ShowWhenStuck"),
    (UnstuckKey, "Unstuck", "Key"));