Skip to content

The mod lifecycle

RSMM is, at its core, a reversible install-time file applier. Knowing the lifecycle explains why mods are safe to add and remove at will.

flowchart LR
    A["mods/&lt;id&gt;/<br/>manifest.toml + assets"] --> B["rsmm apply"]
    B -->|"back up original"| K["&lt;file&gt;.rsmm.bak"]
    B -->|"install override"| C["_Cooking/&lt;encoded&gt;"]
    B --> S[".rsmm_state.json"]
    R["rsmm restore --all"] -->|"restore from .bak"| C
    R --> S

The stages

  1. Stage — you author a mod under mods/<id>/ (a manifest.toml plus assets). The SDK can emit cooked assets for you; see Mods ship data, not code.
  2. Applyrsmm apply resolves each decoded asset path to its encoded cooked path, backs the original up as <file>.rsmm.bak, then copies the override into place. The applier is transactional.
  3. Track — active overrides are recorded in <install>/DarkTalesResources/_Cooking/.rsmm_state.json.
  4. Restorersmm restore --all copies every .rsmm.bak back and deletes the backups, returning the game to vanilla.

Common problems