Home

Welcome to the MCM-Helper wiki!

The documentation here, like the project itself, is heavily based on Fallout 4 MCM and SkyUI.

The Mod Configuration Menu (MCM) is a control panel for mods that is provided by SkyUI for Skyrim. MCM Helper streamlines access to SkyUI's API by providing its own API, which is more similar to that of F4MCM.

MCM menus live in their own directory in MCM\Config\ModName, while user settings are located in MCM\Settings\ModName.ini.

Folder Structure

Data/
└── MCM/
    ├── Config/
    │   ├── Mod1/
    │   │   ├── config.json         (Required) Menu Layout
    │   │   ├── keybinds.json       (Optional) Keybind Definitions
    │   │   ├── settings.ini        (Optional) Mod Setting Defaults
    │   ├── Mod2/
    │   │   └── ...
    │   └── Mod3/
    │       └── ...
    └─── Settings/
         ├── Mod1.ini               Mod Settings for Mod1
         ├── Mod2.ini               Mod Settings for Mod2
         └── Mod3.ini               Mod Settings for Mod3

Getting Started

A configuration menu must at minimum, have a quest with an appropriate Papyrus script attached, and have a config.json file defined. These are responsible for registering the menu with SkyUI, and describing the layout of the config menu, respectively.

For information about config scripts, see Creating a Config Script and Papyrus Integration.
For information about config.json, see Menu Layout and Control Types.
For information about settings.ini, see Setting Types, Storage, and Persistence.
For information about keybinds.json, see Hotkeys.