ModSettings
Adds a Mods tab to the game's settings screen. Other mods register switches, sliders and dropdowns backed by their MelonPreferences with one call each. IL2CPP.
About this mod Author’s original text
Mod Settings
Puts mod options where players look for them: a Mods tab on the game's own settings screen,
in the main menu and the pause menu. It uses the game's switches, sliders and dropdowns, so it
looks and behaves like the rest of the menu.
On its own it does nothing. Mods that use it list their options under their own heading.
Changes apply straight away and are saved to UserData/MelonPreferences.cfg.
For mod authors
Reference ModSettings.dll, add holyfurries-ModSettings to your dependencies,
and register your existing MelonPreferences entries in OnInitializeMelon:
MelonPreferences_Category preferences = MelonPreferences.CreateCategory("MyMod");
MelonPreferences_Entry enabled = preferences.CreateEntry("enabled", true);
MelonPreferences_Entry size = preferences.CreateEntry("size", 1f);
MelonPreferences_Entry corner = preferences.CreateEntry("corner", Corner.TopRight);
Settings.toggle("My Mod", "Show overlay", enabled);
Settings.slider("My Mod", "Overlay size", size, minimum: 0.5f, maximum: 3f);
Settings.dropdown("My Mod", "Overlay corner", corner);
- The entry stays the source of truth. Read entry.Value as usual, or subscribe to
entry.OnEntryValueChanged to react.
- Changing the entry from code, such as a hotkey, updates the control.
- slider takes whole_numbers: true for integer steps. dropdown works with any enum and
lists its names as words (TopCenter shows as "Top Center").
- Up to 128 settings in total. Labels are at most 48 characters, mod names 32.
If a game update changes the settings screen, the tab is skipped with a warning in the log and
the config file keeps working.
Installation
Install with a mod manager, or copy Mods/ModSettings.dll into the game's Mods folder
with MelonLoader 0.7.3 (IL2CPP).
Development
See BUILDING.md and DEVELOPMENT.md.
License
MIT
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: