Skymods

Quasimorph Mods Catalogue

Mod Configuration Menu

Uploaded ·

If you liked this item, please rate it up on Steam Workshop page.

Author: Crynano

Last revision: 28 Jan at 20:40 UTC

File size: 2.27 MB

On Steam Workshop

Description:
Quasimorph Mod Configuration Menu

Mod Configuration Menu (MCM) allows the player to configure mods through the game’s native UI.

It adds a new button in the Main Menu called "Mods", where you will be able to configure any mod that has compatibility with it.

NOTE: This mod is still in development. It could stop working or a mod implementing it could cause it to stop working. if this happens please let me know in this BUGS thread.

Compatibility

This mod should be compatible with any mod.

For Developers

Adding MCM support to your mod is fairly easy.

  1. Register using its API call
    ModConfigMenuAPI.RegisterModConfig(modName, configFilePath, onConfigSaved)
    1. modName parameter is used for the label and internal identification.
    2. configFilePath must be the full path to the config file including the .ini extension.
    3. onConfigSaved is a callback triggered when the user stores the config for your mod. The config is sent as Dictionary<string, object>.
  2. The mod will create a file located in the same folder as your config. This file will be handled by MCM, but can be edited manually by the user with no issue. The name will be your config file name ended with "_mcm.ini".
  3. Read your updated config file whenever you want or use the callback to update the config at your liking.

In newer versions of the MCM, you can omit the .ini file and register using a list of properties. The constructors for them will help you setup everything you need.

If you need any kind of help with it, you can contact me via Quasimorph’s discord server, in the modding channel, or in the post for MCM under the modding forum.

NOTE: To recover your MCM controlled file name, call

ModConfigMenuAPI.GetNameForConfigFile(fileName)

Support

If you enjoy what I do and want me to keep doing it, you can check my Ko-Fi[ko-fi.com] page.
I accept suggestions or we can talk if you wish a for a specific mod.

Credits
  • Crynano: Design, Programming and Implementation.
  • Special thanks to Raigir, NBK_RedSpy, Lynchantiure and Badryuner for their feedback.
  • Thanks to Sergey for the Workshop Icon!

Resources
  • mmaletin: Color Picker[github.com]
  • Magnum Scriptum: Original UI, Sprites and Color Palette.
Download

Tags: