ResoniteModLoader

ResoniteModLoader

A mod loader for Resonite utilizing the built-in plugin system. Consider joining our community on Discord for support, updates, and more.

Installation

1. Download ResoniteModLoader.dll to Resonite’s Libraries folder (C:\Program Files (x86)\Steam\steamapps\common\Resonite\Libraries). You may need to create this folder if it’s missing.
2. Place 0Harmony.dll into a rml_libs folder under your Resonite install directory (C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_libs). You will need to create this folder.
3. Add the following to Resonite’s launch options: -LoadAssembly Libraries/ResoniteModLoader.dll. If you put ResoniteModLoader.dll somewhere else you will need to change the path.
4. Optionally, add mod DLL files to a rml_mods folder under your Resonite install directory (C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods). You can create this folder yourself or launch Resonite once with ResoniteModLoader installed and it will be created automatically.
5. Start the game. If you want to verify that ResoniteModLoader is working you can check the Resonite logs. (C:\Program Files (x86)\Steam\steamapps\common\Resonite\Logs). The modloader adds some very obvious logs on startup, and if they’re missing something has gone wrong. Here is an example log file where everything worked correctly.

If ResoniteModLoader isn’t working after following these steps, take a look at our troubleshooting page.

Finding Mods

For an easy way to find and manage mods, check out Resolute. It simplifies the installation and updating for verified mods from the mod manifest.

New mods and updates also are posted in our Discord.

Example Directory Structure

Your Resonite directory should now include the following folder structure (rml_config and rml_mods will be created automatically on first launch). Files not related to modding are not shown.

<Resonite Install Directory>
│   Resonite.exe
├───/Libraries
|       ResoniteModLoader.dll
├───/Logs
│       <Log files will generate here>
├───/rml_config
│       <Mod configs are created here>
├───/rml_libs
│       0Harmony.dll
│       <Addition libraries for mods here>
└───/rml_mods
        <Add mods here>

Frequently Asked Questions

Many questions about what RML is and how it works are answered on our frequently asked questions page.

Making a Mod

Add <PackageReference Include="ResoniteModLoader" Version="5.0.1" /> in your csproj file or reference your local game install.

Check out the Mod Creation Guide on the wiki.

Configuration

ResoniteModLoader aims to have a reasonable default configuration, but certain things can be adjusted via an optional config file or in-game in the settings tab.

Contributing

Issues and PRs are welcome. Please read our Contributing Guidelines!

Licensing and Credits

ResoniteModLoader is licensed under the GNU Lesser General Public License (LGPL). See LICENSE.txt for the full license.

Third-party libraries distributed alongside ResoniteModLoader:

• LibHarmony (MIT License)

Third-party libraries used in source:

• .NET (Various licenses)
• Resonite (EULA)
• Json.NET (MIT License)