RoRR Modding Toolkit
[Legacy - use ReturnsAPI] Friendly abstractions of the game's internal functions for easier modding.
About this mod Author’s original text
ReturnsAPI should be used instead over this.
Friendly abstractions of the game's internal functions for easier modding.
Documentation can be found here.
Include RoRRModdingToolkit-RoRR_Modding_Toolkit-1.2.26 as a dependency in manifest.json.
To auto-add RMT class references directly to your workspace, place the following line in your code:
mods["RoRRModdingToolkit-RoRR_Modding_Toolkit"].auto()
Alternatively, you can store these references in a variable:
local RMT = mods["RoRRModdingToolkit-RoRR_Modding_Toolkit"].setup()
Current Functionality
- General-purpose helper functions
- GameMaker structure wrapping (arrays and ds_lists)
- Instance finding
- Callback setup
- Network syncing
- Custom content
- Buffs
- Items and Equipment
- Difficulties
- Objects
- Survivors, Skills, and States
- Stages
- etc.
Installation Instructions
Install through the client or r2modman (more detailed instructions here if needed).
Join the Return of Modding server for support.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide. If the mod depends on a loader such as ReturnOfModding, install it first as the readme describes.
Install these first, or the mod will not work: