Creating a Config Script - Exit-9B/MCM-Helper GitHub Wiki

A config menu is controlled by a Papyrus script. MCM Helper does abstract out much of the complexity of SkyUI's original design, but setting up a script is still required.

MCM Helper's config menus have to extend MCM_ConfigBase, which is provided by the MCM Helper SDK. This script must be bound to a quest in the Creation Kit.

Consequently, to create a new config menu for your mod, you have to

  • create a new script that will control your config menu. For now, it doesn't have to be more than this:
Scriptname MyConfigMenu extends MCM_ConfigBase
  • create a new quest and attach your script to it.
    (Caution: In the Creation Kit, you must click OK on the Quest dialog in order to finish creating the form, before you attach any scripts to it. Otherwise it will crash.)

After this, there is one, very important, thing left to do here. Each config menu has to run some maintenance code when the game is reloaded. This has to be set up manually:

  • In the quest you created, select the Quest Aliases tab and add a new reference alias. Name it PlayerAlias.
  • For Fill Type, select the player reference (Specific Reference, Cell any, Ref PlayerRef).
  • In the Scripts list, add SKI_PlayerLoadGameAlias.

This screenshot shows what the reload alias setup it looks like in the end.

Both this script setup and the Menu Layout step must be done in order for the menu to show up in the control panel.

See Papyrus Integration for more information on how you can use your Papyrus script(s).