Your first mod

Install a mod (desktop app)

1. Open Ravenswatch Mod Manager.
2. Go to the Registry tab — browse mods uploaded by the community.
3. Click a mod to view its details, screenshots, and description.
4. Click Install — the mod downloads into your local collection.
5. Click Apply — RSMM copies the mod’s files into your Ravenswatch install.
6. Launch the game and enjoy.

Tip

To uninstall: open the Installed tab, find the mod, click Uninstall, then Apply to revert.

Create your own mod (CLI)

Mods ship data, not code — a declarative manifest.toml plus assets the SDK emits. No bespoke scripts.

1. Scaffold a new mod:

   ./rsmm new MyMod

   This creates mods/MyMod/manifest.toml.

2. Describe your mod — edit manifest.toml and drop overrides under mods/MyMod/assets/:

   [mod]
   id = "MyMod"
   name = "My First Mod"
   version = "0.1.0"
   
   [[content]]
   kind = "texture"
   target = "path/to/original.png"
   source = "assets/my-texture.png"

3. Apply your changes to the game:

   ./rsmm apply

4. Package for sharing:

   ./rsmm pack MyMod        # produces dist/MyMod.zip

Upload dist/MyMod.zip via the Registry tab to share it with the community.

Caution

Don’t author mods as Python scripts — rsmm lint (and CI) reject stray *.py in a mod that isn’t a sanctioned lifecycle hook. If you need new capability, it graduates into the SDK. See Authoring mods.

Next steps

Authoring mods The full mod-authoring guide.

SDK (v3) The Python SDK that emits mod assets.

CLI reference All available commands.