Quickstart

Paid Shill

Throughout this documentation, there have been a lot of references to Rusted Moss Mod Loader (RMML). RMML is a tool created by me to aid in my personal modding journey (not that it can’t be used by others), and its design is heavily influenced by its history. I highly recommend using it, or building something similar, if you are going to do serious modding.

This article contains detail on how to install RMML and the basics for making mods with it.

Install

RMML is available on the rm-mod-manager Github page. Download the latest release’s rmml_{VERSION}.zip file, and unzip it into the Steam mods folder, replacing meta_info.ini.

mods/
├── asset_list.ini
├── constant_list.ini
├── function_list.ini
├── meta_info.ini
├── method_list.ini
├── modlist.txt
├── rmml/
   ├── rmml.meow
   └── rmmm.md
├── rmml.ini
└── sniper_bnuy.ini

You can write mods using the “standard” .ini syntax or RMML’s .md syntax (or index.csv). Mods written with RMML installed should be placed in the mods/rmml folder and enabled with Rusted Moss Mod Manager in-game, or added to the modlist.

INI Mod VS RMML Mod
INI File.md Mod
[object_list]
controller = enabled
instance = enabled
[controller_events]
create='show_message("Foo")'
room_start='show_message("Bar")'
[instance_events]
create='self.y += self.vsp; self.vsp *= 0.5; if self.vsp < 0.1 { instance_destroy(self) }'
# controller
## create
```
show_message("Foo")
```

## room_start
```
show_message("Bar")
```

# instance
## create
```
self.y += self.vsp
self.vsp *= 0.5
if self.vsp < 0.1 {
  instance_destroy(self)
}
```

For more information about the syntax, check out the full page.

RMML also uses the save folder for storing logs and other information. If you’re using Rusted Moss Mod Manager (which comes installed with RMML), any mods you download are also in that folder. On Windows, this is %LocalAppData%/RustedMoss. For more information about how RMML works, see the full article.

Rusted Moss Mod Manager

RMML comes installed with Rusted Moss Mod Manager (RMMM). This mod lets you download mods off the internet, manage your mod installation, and adds safety features.

modlist.txt

RMML completely bypasses Rusted Moss’s mod loading when loading other mods, and doesn’t read the mod list in meta_info.ini. Instead, the file modlist.txt in the mods directory stores a list of mods to load.

# put your mods here (or disable them with #)
# mods are loaded (and run) in the order written here
rmml_modlister.md
ccw_shark.md
cc_shark.md

my_mod_here.md
my_other_mod.ini
your_mod_folder/mod_name.md

If you’re using RMMM, this file is located in the saves folder instead of the Steam folder. If you’re using RMMM, I recommend ignoring this file, and using RMMM to manage your mods in-game instead.