Installing mods

Installing mods for Resonite 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 three major mod loaders for Resonite:

• ResoniteModLoader (RML) is the oldest and simplest mod loader. It utilizes the existing plugin system to load Harmony and apply patches. It can be seen as the "old reliable".
• MonkeyLoader (ML) is a newer mod loader using NuGet packages for mods. It is feature-heavy and strives to provide an all-in-one experience. It provides optional mod compatiblity with RML, so RML mods can work with it.
• BepisLoader (BL) is the newest mod loader on the scene. It uses the mature BepInEx modding framework used by many other games. It leverages the Thunderstore infrastructure to allow the use of highly popular mod managers such as r2modman and Gale. It also provides optional compatibility with both RML and ML mods. It thrives to stay lightweight while providing advanced functionality using addons.

Which mod loader you use is entirely up to you.

For completeness, this guide will go over installing all three mod loaders. It is recommended for most users to not install multiple mod loaders on the same Resonite installation—only use one at a time. If you install multiple mod loaders there is a risk of encountering issues - you should be highly experienced in modding before attempting this.

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.

Post-installation recommendations

For 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.

MonkeyLoader

See the ML GitHub page.

This article or section is a stub. You can help the Resonite wiki by expanding it.

BepisLoader

See official BL wiki page.

This article or section is a stub. You can help the Resonite wiki by expanding it.

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|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.