Home

Welcome to the MCM wiki!

The Mod Configuration Menu is a settings page for mods.

It provides a central location for mod configuration, accessible via the Pause menu.

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
│   │   │   ├── settings.ini        (Optional) Mod Setting Defaults
│   │   │   ├── keybinds.json       (Optional) Keybind Definitions
│   │   │   └── lib.swf             (Optional) Image library
│   │   ├── Mod2/
│   │   │   └── ...
│   │   └── Mod3/
│   │       └── ...
│   └── Settings/
│       ├── Mod1.ini                Mod Settings for Mod1
│       ├── Mod2.ini                Mod Settings for Mod2
│       └── Mod3.ini                Mod Settings for Mod3
└── Interface/
    └── Translations/
        ├── Mod1_en.TXT             (Optional) English translations for Mod1
        ├── Mod1_fr.TXT             (Optional) French translations for Mod1
        ├── Mod2_en.TXT             (Optional) English translations for Mod2
        ├── Mod2_fr.TXT             (Optional) French translations for Mod2
        ├── Mod3_en.TXT             (Optional) English translations for Mod3
        └── Mod3_fr.TXT             (Optional) French translations for Mod3

Getting Started

A configuration menu must at minimum, have a config.json file defined. This file describes the layout of the config menu.

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.
For information about lib.swf, see Advanced.