Skip to content

README.md

Latest commit

 

History

History
58 lines (40 loc) · 2.01 KB

README.md

File metadata and controls

58 lines (40 loc) · 2.01 KB

Audica Mod Settings

This mod lets players change mod settings from within the game.

Banner

Installation

  • Download the latest MelonLoader version from here
  • Grab the latest mod release from here
  • Place the dll file into Audica/Mods
  • Use the Mod Settings button from main menu.

To modders

For a quick start you can use this config as an example.

Min Max Step Default

MelonPrefs don't have a way to set step values or default values. You'll have to use the display string to set them.

Format:
[0,5,0.2,1.4]
[Min,Max,Step,Default]

Example:

MelonPrefs.RegisterFloat(Category, nameof(OverlayScale), 1.4f, "Changes the scale of the overlay [0,5,0.2,1.4]");

Format Specifier (Optional)

If you want the display to use a specific format, you can add format specifiers to your display string. The default format specifier is N3.

Format:
{N3}
{FormatSpecifier}

Example:

MelonPrefs.RegisterFloat(Category, nameof(OverlayScale), 1.4f, "Changes the scale of the overlay [0,5,0.2,1.4] {N3}");

Headers (Optional)

You can create headers by using string prefs. If the string pref display string contains[Header], it will display ingame as a divider.

Format:
[Header]

Example:

MelonPrefs.RegisterString(Category, nameof(SpeedSection), "", "[Header]Speed options");

Important
These values will be hidden ingame. int and float prefs will be ignored unless they have MinMaxStepDefault values.

Updating values in your mod

OnModSettingsApplied will get called everytime a value is changed. You might have to update objects within your mod, make sure to do it in the OnModSettingsApplied method.