Config lib

You can support me on Patreon:

---

Requires ImGui

There is an addon you might want to check: Auto Config lib

For other modders (or if you want to help): I need help with wrighting documentation for this library, I'm bad at it and dont have energy to do this stuff. Also I will be happy to have some help with testing new features.

 

This is a library that allows making configs even for content mods (there is also API for code mods, including custom widgets) and provides a unified GUI for editing them in game. It does not require for your mod to depend on this library. If the library is not installed, default values from assets will be used.

This library also allows changing values in regular JSON patches, that can be valuable for server configurations and can make tweaking other mods for server needs much easier.

 

Documentation on JSON API of this library (written by Somnium). If you want to help keep documentation up-to-date, expand it and help test new features, please ping me in discord, any help will me much appreciated.

If you need help with adding a config file using this lib feel free to ping me in discord on official VS server.

Thanks Somnium for feature suggestions and help with testing them, and the documentation.

Some of the mods that use this library:

• Status Hud Continued
• BetterRuins
• Crossbows
• Firearms
• Wild Farming
• Millwright
• Translocator Engineering - Redux
• Sortable Storage
• Zoom Button - Reborn
• Buzzwords
• Primitive Survival
• Vanilla Variants
• BetterTraders
• Mobs Radar
• Dana Tweaks
• Real Currency
• Smithing Plus

Feel free to request any features you might need under mod's discord post (link is above in Homepage tab).

 

Example of adding config reload functionality keeping optional dependency:

public sealed class CombatOverhaulSystem : ModSystem
{
    public Settings Settings = new();

    public override void Start(ICoreAPI api)
    {
        if (api.ModLoader.IsModEnabled("configlib"))
        {
            SubscribeToConfigChange(api);
        }
    }

    private void SubscribeToConfigChange(ICoreAPI api)
    {
        ConfigLibModSystem system = api.ModLoader.GetModSystem<ConfigLibModSystem>();

        system.SettingChanged += (domain, config, setting) =>
        {
            if (domain != "combatoverhaul") return;
            setting.AssignSettingValue(Settings);
        };
        system.ConfigsLoaded += () =>
        {
            system.GetConfig("combatoverhaul")?.AssignSettingsValues(Settings);
        };
    }
}