MLib is unfinished. If I recall correctly, it was working quite well, but still had a few major bugs. Feel free to use it, but those bugs will definitely need fixing before it can truly be useful.

MLib is a library for Skyrim that helps with developing MCM menus by making their development more structured. In particular, it allows splitting MCMs into multiple files (one per page), simplifies the tooltip mechanic and also offers some utility methods for common tasks.

For an example of a mod that uses it, see Anofeyn (the _AF_MCM_* scripts, in particular).

• Skyrim Special Edition (Legendary should work, but is not tested)
• SkyUI
• SkyUI SDK

If you're using git, add MLib as a submodule:

git submodule add https://github.com/Infernio/MLib

In your build script (for an example build script, see Anofeyn's or Campfire's), you should then copy the sources from MLib/scripts to the temporary build folder.

Feel free to redistribute the script files - it's unlikely that MLib will ever need major updates. But, if you want to be 100% sure, you can add MLib.esp as a master and rely on it to provide the scripts.

To create an MCM with this library, first create a quest with a player reference alias and attach SKI_PlayerLoadGameAlias, as you normally would.

Then, open the Scripts tab and add an instance of the MLib_Config script. Edit this script's properties:

• ModName: The title of your mod's MCM. Same as standard SkyUI.
• Pages: Leave this alone. It comes from SkyUI, but will now be filled by MLib automatically.
• PageScripts: This is where you'll add your pages. We'll come back to this one in a minute.
• Version: The current version of your mod's MCM. You can increase this whenever important changes occur to the mod / MCM and take advantage of MLib's OnVersionUpdate events (more on that later).

Head back to the Quest Aliases tab and add new player reference aliases, one for each page you want the MCM to have.

Now it's time to create scripts for the actual pages. Make a new script for each page you want the MCM to have. Each of those scripts must extend the MLib_Page script, giving you something like this:

ScriptName _MyMod_PageGeneral Extends MLib_Page

String Function GetTitle()
    return "$MyModPageGeneral"
EndFunction

Note: The title obviously does not have to be localized.

After all those scripts have been created, turn your attention back to the player reference aliases you created earlier. Attach the appropriate script to each of those aliases.

Finally, head back to the Scripts tab on your quest and edit the properties of the MLib_Config script again. Add all the aliases we just created to the PageScripts property.

And that's it! You can now head down to the Adding content to the pages section to see documentation on how to add options to the pages.

Follow the steps outlined above - but instead of creating a new quest, just reuse your existing MCM quest by removing the existing MCM script and attaching the MLib_Config script.

You can then, for the most part, just copy-paste parts of your MCM script into the page scripts. Have a look at the Adding content to the pages section for more information on the page scripts and how they differ from a full MCM script.

Note: This section details how to create an MLib release for the Nexus. There is no need to do this if you just want to use MLib for a project - follow the instructions in the Adding it to a project section instead.

• Install all requirements listed above.
• In build.sh, change the variable SKYRIM_PATH to point to your Skyrim installation.
  • Note: You may need to make further changes to variables here if you use a non-standard Skyrim installation.
• Also in build.sh, change the variable VERSION to the version you want to build.
• Run ./build.sh. You will need a bash interpreter for this, I recommend Git Bash.

Note: If you want to use Atom for development, you will have to edit .build-papyrus.yml to match your setup.

MLib is licensed under the MIT License.