Modding/Installing mods

Installing mods consists of a few steps:

1. Installing a mod loader
2. Downloading mods
3. Moving mods to the mod directory

Tools exist to simplify steps 2 and 3 into one step.

Choosing a mod loader

There are currently two major mod loaders for Resonite:

• ResoniteModLoader is the oldest and simplest mod loader. It utilizes the existing plugin system to load Harmony and patch functions.
• MonkeyLoader is a slightly newer mod loader using NuGet packages for mods. It also provides mod compatiblity with RML, so RML mods will work with it.

Which mod loader you use is entirely up to you. RML is simple and battle-tested yet lacks batteries, relying mostly on external mods to provide seemingly basic functionality. ML is newer, has RML mod compatibility, and has more batteries included at the expense of being generally larger.

For completeness, this guide will go over installing both mod loaders. You should not install both mod loaders on the same Resonite installation—use one or the other.

ResoniteModLoader

Installing the mod loader

To install ResoniteModLoader:

1. Navigate to your Resonite installation directory. This can be found by right clicking Resonite in your Steam library then choosing "Browse local files".
2. Create three folders in this directory if they do not already exist:
   • Libraries
   • rml_libs
   • rml_mods
3. Open the releases page for RML and download:
   • 0Harmony.dll. Place this file in the rml_libs folder.
   • ResoniteModLoader.dll. Place this file in the Libraries folder.
4. Add the launch argument -LoadAssembly Libraries\ResoniteModLoader.dll (for Windows) or -LoadAssembly Libraries/ResoniteModLoader.dll (for Linux) to load the mod loader when launching Resonite.

And now RML should be installed.

Installing mods

Manually

To install mods, download the .dll file associated with the mod and place it in the aforementioned rml_mods folder.

Most mods are developed and distributed on GitHub. When given a GitHub repository link, such as ResoniteModSettings, the .dll file for the mod will usually be in the "Releases" page on the right side of the site.

Some mods will require other .NET libraries to function as well. An example of this is the EyeTrackVRResonite mod. For mods with these extra libraries, the main mod DLL will go under rml_mods as usual (in this case, EyeTrackVRResonite.dll), and any extra DLLs will go under rml_libs (in this case, OscCore.dll).

Resolute

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Resolute is a mod manager to simplify the steps of installing mods. It can be downloaded and installed from its releases page.

MonkeyLoader

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Post-installation recommendations

If you are using RML, it is highly recommended to install the ResoniteModSettings mod, as it allows you to configure the settings of mods without needing to manually edit the text file for mod settings nor restart the game.

Keeping up with updates

The simplest way to keep up with RML mod updates is by using Resolute, as it tracks changes made to the mod manifest.

Alternatively, the FrooxEngine Modding Discord houses the #resonite-mod-releases channel that one can subscribe to to get information about mod releases.

Most mods are hosted on sites that provide a web feed to subscribe to new release publishings. These feeds can be subscribed to using a feed aggregator to keep up to date with new releases for any given mod. An example feed link is the releases feed for ResoniteModSettings.