skyrim-mcm
Create and edit MCM Helper configuration files for mod settings menus. Use when the user wants to add in-game settings, configuration options, toggles, sliders, or dropdowns to their mod.
When & Why to Use This Skill
This Claude skill automates the creation and management of MCM (Mod Configuration Menu) Helper configuration files for Skyrim modding. It streamlines the development process by providing a structured CLI interface to generate valid JSON configurations, allowing modders to easily implement in-game settings like toggles, sliders, and dropdowns without manual JSON editing.
Use Cases
- Case 1: Rapidly generating a standardized MCM configuration file for a new Skyrim mod to establish an in-game settings menu.
- Case 2: Adding interactive UI elements such as boolean toggles for feature switches or float sliders for gameplay variables like damage multipliers.
- Case 3: Organizing complex mod settings into multiple categorized pages (e.g., 'General', 'Combat', 'Magic') to improve user navigation and experience.
- Case 4: Validating MCM JSON files against the MCM Helper schema to identify syntax errors or structural issues before deploying the mod.
- Case 5: Synchronizing MCM control IDs with plugin GlobalVariables to ensure seamless communication between the user interface and Papyrus scripts.
| name | skyrim-mcm |
|---|---|
| description | Create and edit MCM Helper configuration files for mod settings menus. Use when the user wants to add in-game settings, configuration options, toggles, sliders, or dropdowns to their mod. |
Skyrim MCM Module
Create and edit MCM Helper configuration files for in-game mod settings menus using Spooky's AutoMod Toolkit.
Prerequisites
Run all commands from the toolkit directory:
cd "<TOOLKIT_PATH>"
# Example: cd "C:\Tools\spookys-automod-toolkit"
Overview
MCM (Mod Configuration Menu) allows mods to have in-game settings menus. This module generates JSON configuration files compatible with MCM Helper.
Command Reference
Create MCM Configuration
dotnet run --project src/SpookysAutomod.Cli -- mcm create "<modName>" "<displayName>" --output "<file>"
| Option | Description |
|---|---|
<modName> |
Internal mod name (no spaces, used for file paths) |
<displayName> |
Display name shown in MCM menu |
--output, -o |
Output file path |
Get MCM Info
dotnet run --project src/SpookysAutomod.Cli -- mcm info "<config>"
Validate MCM Configuration
dotnet run --project src/SpookysAutomod.Cli -- mcm validate "<config>"
Add Toggle (Checkbox)
dotnet run --project src/SpookysAutomod.Cli -- mcm add-toggle "<config>" "<id>" "<text>" [options]
| Option | Description |
|---|---|
<config> |
Path to config.json |
<id> |
Control identifier (e.g., bEnabled) |
<text> |
Display text |
--help-text |
Help text shown on hover |
--page |
Target page name |
Add Slider
dotnet run --project src/SpookysAutomod.Cli -- mcm add-slider "<config>" "<id>" "<text>" --min <n> --max <n> [options]
| Option | Default | Description |
|---|---|---|
<config> |
Required | Path to config.json |
<id> |
Required | Control identifier (e.g., fDamage) |
<text> |
Required | Display text |
--min |
0 | Minimum value |
--max |
100 | Maximum value |
--step |
1 | Step increment |
Common Workflows
Create Basic Mod Settings
# 1. Create the MCM config
dotnet run --project src/SpookysAutomod.Cli -- mcm create "MyMod" "My Awesome Mod" --output "./MCM/config/MyMod/config.json"
# 2. Add an enable toggle
dotnet run --project src/SpookysAutomod.Cli -- mcm add-toggle "./MCM/config/MyMod/config.json" "bEnabled" "Enable Mod" --help-text "Turn the mod on or off"
# 3. Add a debug toggle
dotnet run --project src/SpookysAutomod.Cli -- mcm add-toggle "./MCM/config/MyMod/config.json" "bDebugMode" "Debug Mode" --help-text "Show debug messages"
# 4. Add a damage multiplier slider
dotnet run --project src/SpookysAutomod.Cli -- mcm add-slider "./MCM/config/MyMod/config.json" "fDamageMultiplier" "Damage Multiplier" --min 0.5 --max 3.0 --step 0.1
# 5. Validate the configuration
dotnet run --project src/SpookysAutomod.Cli -- mcm validate "./MCM/config/MyMod/config.json"
Create Multi-Page Settings
# Create config
dotnet run --project src/SpookysAutomod.Cli -- mcm create "MyMod" "My Mod" --output "./MCM/config.json"
# Add controls to "General" page (default)
dotnet run --project src/SpookysAutomod.Cli -- mcm add-toggle "./MCM/config.json" "bEnabled" "Enable Mod"
# Add controls to "Combat" page
dotnet run --project src/SpookysAutomod.Cli -- mcm add-slider "./MCM/config.json" "fDamage" "Damage Bonus" --min 0 --max 100 --page "Combat"
dotnet run --project src/SpookysAutomod.Cli -- mcm add-toggle "./MCM/config.json" "bCritical" "Enable Criticals" --page "Combat"
# Add controls to "Magic" page
dotnet run --project src/SpookysAutomod.Cli -- mcm add-slider "./MCM/config.json" "fSpellCost" "Spell Cost Reduction" --min 0 --max 50 --page "Magic"
Validate and Check Existing MCM
# Check MCM structure
dotnet run --project src/SpookysAutomod.Cli -- mcm info "./MCM/config/SomeMod/config.json"
# Validate for errors
dotnet run --project src/SpookysAutomod.Cli -- mcm validate "./MCM/config/SomeMod/config.json"
MCM Helper Integration
Required File Structure
MCM Helper expects files in specific locations:
Data/
MCM/
config/
MyMod/
config.json # Main config (required)
settings.ini # Default values (optional)
translations/
MyMod_english.txt # Translations (optional)
Config JSON Format
Generated config.json structure:
{
"modName": "MyMod",
"displayName": "My Awesome Mod",
"minMcmVersion": 7,
"pages": [
{
"pageDisplayName": "Main",
"content": [
{
"type": "toggle",
"id": "bEnabled",
"text": "Enable Mod"
},
{
"type": "slider",
"id": "fDamage",
"text": "Damage Multiplier",
"min": 0.5,
"max": 2.0,
"step": 0.1
}
]
}
]
}
Control Types
| Type | Description | Properties |
|---|---|---|
| toggle | Checkbox | id, text, help |
| slider | Value slider | id, text, min, max, step |
| dropdown | Dropdown list | id, text, options |
| keymap | Key binding | id, text |
| text | Text input | id, text |
Linking MCM to Scripts
MCM values are stored as GlobalVariables in your plugin:
ScriptName MyMod_ConfigScript extends Quest
; These must match the MCM control IDs
GlobalVariable Property bEnabled Auto
GlobalVariable Property fDamageMultiplier Auto
Function ApplySettings()
If bEnabled.GetValue() == 1
float damage = fDamageMultiplier.GetValue()
; Apply settings...
EndIf
EndFunction
Naming Conventions
Control IDs
Follow Hungarian notation for clarity:
bSomething- Boolean togglesfSomething- Float slidersiSomething- Integer valuessSomething- String values
Examples
bEnabled- Main enable togglebDebugMode- Debug mode togglefDamageMultiplier- Damage multiplier (float)iItemCount- Item count (integer)fSpellCostReduction- Spell cost reduction percentage
Important Notes
- MCM Helper required - Users must have MCM Helper installed
- GlobalVariables must exist - Create matching globals in your plugin
- File location matters - Place config in
Data/MCM/config/ModName/ - Validate before release - Always run validate command
- Use
--jsonflag for machine-readable output when scripting
Complete MCM + Plugin Workflow
# 1. Create the plugin
dotnet run --project src/SpookysAutomod.Cli -- esp create "MyConfigMod.esp" --light
# 2. Add globals that match MCM controls
dotnet run --project src/SpookysAutomod.Cli -- esp add-global "MyConfigMod.esp" "bEnabled" --type long --value 1
dotnet run --project src/SpookysAutomod.Cli -- esp add-global "MyConfigMod.esp" "fDamageMultiplier" --type float --value 1.0
# 3. Create MCM config
dotnet run --project src/SpookysAutomod.Cli -- mcm create "MyConfigMod" "My Config Mod" --output "./MCM/config/MyConfigMod/config.json"
# 4. Add matching controls
dotnet run --project src/SpookysAutomod.Cli -- mcm add-toggle "./MCM/config/MyConfigMod/config.json" "bEnabled" "Enable Mod"
dotnet run --project src/SpookysAutomod.Cli -- mcm add-slider "./MCM/config/MyConfigMod/config.json" "fDamageMultiplier" "Damage Multiplier" --min 0.5 --max 2.0 --step 0.1
# 5. Validate
dotnet run --project src/SpookysAutomod.Cli -- mcm validate "./MCM/config/MyConfigMod/config.json"
JSON Output
All commands support --json for structured output:
dotnet run --project src/SpookysAutomod.Cli -- mcm info "./config.json" --json