CMIConfig Guide

This page introduces CMIConfig as a public staff guide. It focuses on what the tool does, how authorized staff get started, and which commands are useful.

What It Does

Owner GUI for selected server library config toggles with backups and reload prompts.

How Staff Use It

Start with /cmiconfig. The sections below explain what CMIConfig is for, which commands authorized staff can use, and what its output means.

Available features include:

• /cmiconfig opens an index GUI for CMI and CMILib config surfaces.
• First page links to CMI config.yml, CMI modules.yml, selected CMI Settings/*.yml files, and CMILib config.yml when present.
• Per-file pages show discovered boolean toggles with on/off dye indicators.
• Click a toggle to open a confirmation screen.
• Confirm only, or confirm and run the configured reload command such as cmi reload.
• Creates a timestamped backup next to the edited YAML file before writing.
• Uses a targeted line edit so CMI’s comments and most formatting are preserved.
• Marks modules.yml as restart-recommended because many module changes may not fully apply with /cmi reload, even though the GUI can still offer confirm-and-reload.

Quick Start

1. Start with /cmiconfig to open or view CMIConfig.
2. Use /cmiconfig status to check your current progress, settings, or state.
3. Try /cmiconfig open when you are ready to use one of the feature actions.

Commands

Command	What it does	Example
/cmiconfig	Opens or shows the main CMIConfig player view.	/cmiconfig
/cmiconfig open	Opens a specific CMIConfig menu or entry.	/cmiconfig open
/cmiconfig status	Shows your current CMIConfig status.	/cmiconfig status
/cmiconfig scan	Runs the CMIConfig scan action.	/cmiconfig scan

Examples

• No separate examples are listed yet. Use the command examples above as a starting point.

Good To Know

• This is a permission-gated staff or server-management feature, not a normal player feature.
• Review the full reference before changing settings or using any command that can write data.

Full Reference

The full synced CMIConfig reference is available for exact technical details.