Getting Started

With ContentSettings, getting started is easy!

Installing

After setting up a new BepInEx mod, you can add the package to your project using the following:

• CLI
• CSProj

dotnet add package RedstoneWizard08.ConfigurableWarning

Your First Setting

Here's a basic setting:

public class MySetting : IntSetting, ICustomSetting {
    public override void ApplyValue() {
        // Do something with the value!
        // it's stored in the `Value` property
    }

    public override int GetDefaultValue() => 50;
    protected override (int, int) GetMinMaxValue() => (0, 100);
    public string GetDisplayName() => "My Setting";
}

Registering the Setting

There are two ways to register a setting:

• Using the SettingRegister attribute
• Using the SettingsLoader

[SettingRegister("MY STUFF", "GENERAL")]
public class MySetting : IntSetting, ICustomSetting {
    // ...
}

Accessing its State

To access your setting's state, you need to set it somewhere else in the ApplyValue method.

Example:

public static class MySettingValues {
    public static int MySettingValue = 50;
}

[SettingRegister("MY STUFF", "GENERAL")]
public class MySetting : IntSetting, ICustomSetting {
    public override void ApplyValue() {
        MySettingValues.MySettingValue = Value;
    }
}

In this example, you can access MySetting's value from the MySettingValues.MySettingValue field.