ContentSettings
A library for adding custom settings to Content Warning.
About this mod Author’s original text
ContentSettings
A library for adding custom settings to Content Warning.
Features
- [x] Register custom settings
- [x] Manual registration
- [x] Attribute-based registration
- [x] Custom categories
- [x] Addition inputs
- [x] Text input (TextField)
- [x] Integer input (Slider)
- [x] Boolean input (Checkbox)
Planned
- More input types
- Networking support
Usage
If you just want to look at some code, take a look at the Example Plugin.
Registering a Setting
void Awake()
{
SettingsLoader.RegisterSetting("YOUR TAB", new ExampleSetting());
}
public class ExampleSetting: FloatSetting, ICustomSetting
{
public override void ApplyValue()
{
// Do something with the value
}
public override float GetDefaultValue() => 0.5f;
public override float2 GetMinMaxValue() => new(0f, 1f);
public string GetDisplayName() => "Example Setting";
}
Contributing
This repository follows Conventional Commits
Commits will be rejected automatically if they do not follow the format specified below.
Format
(optional scope):
Example: feat(pre-event): add speakers section
Credits
- CommanderCat - Creator and Developer
- dhkatz - Developer and Maintainer
License
Released under GPL-3.0 by @Commander-Cat101.
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.
Install these first, or the mod will not work: