Installation

Get started with Resonite modding by installing a mod loader. BepisLoader is the recommended and most widely supported option - it will be installed automatically when you use a mod manager.

Using a Mod Manager (Recommended)

Mod managers handle all the technical setup for you. They automatically install BepisLoader and manage your mods.

Choose a Mod Manager

Gale

Modern, lightweight mod manager with clean interface.

Install

r2modmanPlus

Open source version of the official Thunderstore Mod Manager.

Install

Thunderstore Mod Manager

Official mod manager for Thunderstore.

Install

Getting Started

1. Launch your mod manager
2. Find Resonite in the game list
3. Browse mods on Thunderstore
4. Install mods you want - BepisLoader installs automatically as a dependency
5. Launch Resonite through the mod manager

Just Works

The mod manager handles everything - BepisLoader installation, mod updates. You don’t need to manually install anything!

---

Manual Installation (Advanced Users)

Not Recommended

Only use manual installation if you need custom configurations or are developing mods. Most users should use mod managers above.

If you need manual control:

1. Download BepisLoader from Thunderstore or GitHub releases
2. Extract the ZIP file
3. Copy the contents of the BepInExPack folder into your Resonite installation root directory
4. Enable the modded entry point:
   Open the hookfxr.ini file in your Resonite installation folder and replace enable=false with enable=true
   Alternatively, you can keep enable=false and add --hookfxr-enable to your game launch options to enable mods on launch
5. Launch Resonite - BepInEx will generate configuration files on first run

Find your Resonite folder:

• Via Steam: Steam > Library > Resonite > Manage > Browse local files
• Windows: C:\Program Files (x86)\Steam\steamapps\common\Resonite
• Linux: ~/.steam/steam/steamapps/common/Resonite

Enabling or Disabling Mods

BepisLoader is not enabled by default after installation. Mods only load when the modded entry point is enabled.

• To enable mods by default, change the setting enable=false to enable=true in hookfxr.ini.
• If you prefer not to edit the ini file, add the command-line argument --hookfxr-enable to launch options instead.
• To temporarily disable mods (even if enabled), add the --hookfxr-disable flag or set enable=false in the ini.

Uninstalling BepisLoader

To fully uninstall BepisLoader and remove all mods, delete the following files and folders from your Resonite installation directory:

• BepisLoader.deps.json
• BepisLoader.dll
• BepisLoader.runtimeconfig.json
• hookfxr.ini
• hostfxr.dll
• LinuxBootstrap.sh
• DirectoryBepInEx/

  • …

Note that the LinuxBootstrap.sh file is modified by BepisLoader and must be restored to the original game version by verifying the integrity of game files on Steam.

Also, remove any --hookfxr-enable or --hookfxr-disable launch flags from your game start parameters.

Verify Integrity of Game Files (Steam)

After uninstalling BepisLoader, verifying the integrity of game files is required to restore modified files (especially LinuxBootstrap.sh) to their original state:

1. Open your Steam Library.
2. Right-click on Resonite and select Properties.
3. Navigate to the Local Files tab.
4. Click Verify integrity of game files….

Steam will scan your installation and replace any modified or missing files, ensuring a clean, unmodded game state.

Alternative Mod Loaders

While BepisLoader is the recommended option (and the only one supported on Thunderstore), there are other mod loaders available for Resonite:

BepisLoader (Recommended)

BepisLoader - Lightweight and modular loader

• Based on mature BepInEx framework (used by many games)
• Full Thunderstore support (massive modding repository)
• Windows: Uses HookFxr to inject
• Linux: Modifies LinuxBootstrap.sh to load BepisLoader.dll
• Lightweight core with features added via libraries:
  • BepisLocaleLoader for localization
  • BepisModSettings for in-game config UI
• Simple and flexible for developers

GitHub Repository

ResoniteModLoader

ResoniteModLoader (RML) - The original basic mod loader

• Fork of NeosModLoader from NeosVR days
• Oldest and most established in the Resonite community
• Largest existing mod ecosystem for Resonite
• Very basic - no advanced features
• Uses Resonite’s official -LoadAssembly plugin loader (no injection)
• JSON manifest system for mod discovery
• Supported by Resolute mod manager

Installation: Place DLL in Libraries folder and add launch option

GitHub Repository | Resolute Manager

MonkeyLoader

MonkeyLoader - Feature-heavy all-in-one loader

• Everything built-in: hot reloading, localization, pre-patching
• Windows: Uses HookFxr to inject
• Linux: Modifies LinuxBootstrap.sh to load MonkeyLoader
• Opinionated development workflow
• Requires NuGet registry for distribution (still WIP)
• GamePack system for extensibility
• More complex setup and development

Installation: Download MonkeyLoader and Resonite GamePack ZIP, extract to Resonite folder

GitHub Repository

Mod Loader Comparison

Feature	BepisLoader	ResoniteModLoader	MonkeyLoader
Philosophy	Lightweight & modular	Basic & minimal	Feature-heavy all-in-one
Thunderstore Support	✅	❌	❌
Mod Distribution	Thunderstore, Manual	JSON manifest, Manual	NuGet (Planned), Manual
Windows Hooking	HookFxr	-LoadAssembly	HookFxr
Linux Hooking	Bootstrap script	-LoadAssembly	Bootstrap script
Installation Method	Mod managers, Manual	Manual	Manual
Mod Manager	✅ r2modman, Gale	✅ Resolute	❌
In-game Config UI	✅ Official addon	✅ Community addon	✅ Built-in
Harmony Patching	✅ HarmonyX	✅ Harmony	✅ Harmony
Pre-patching	✅	❌	✅
Hot Reloading	🟡 Partial 1	✅ Community addon	✅ Built-in
Localization	✅ Official addon	❌	✅ Built-in
Dependency Management	✅ Via Mod Managers	✅ Via Resolute	❌ Manual
Developer Experience	Simple & flexible	Very basic	Complex & opinionated
Learning Curve	Easy	Easy	Steep

Why BepisLoader?

BepisLoader is recommended for new users because:

• Thunderstore integration - Access to a massive, established mod repository.
• Mod manager support - Easy installation and updates with r2modman/Gale.
• BepInEx foundation - Built on proven technology used across many games.
• Works alongside RML and MonkeyLoader - Can use BepisLoader, MonkeyLoader (via MonkeyLoaderLoader) and RML together. ²

Next Steps

Now that you have a mod loader installed:

• Use mods from the community
• Create your first mod to start developing
• Browse mods on Thunderstore to find existing mods

Footnotes

1. It supports .NET Hot Reload provided by your IDE, as long as you launch with a debugger attached. A more complete implementation is planned. ↩

2. Currently only BepisLoader mods are managed through Thunderstore mod managers. ↩