Mod Hot Reloader

Mod Hot Reloader User Guide#

The Mod Hot Reloader allows developers to hot reload mods without restarting the game. Follow this guide to configure and use the tool.

Prerequisites#

• Mod Not Installed: Add a Directory.Build.props file to prevent automatic installation.
• Backend Code Only: The tool does not support UI components, allowing you to rebuild and debug backend code without reloading the game.
• Correct Settings: Configure settings, then use InvokeMethodWithinHotLoadedMod to trigger code within your mod. Check Unity Explorer Log for troubleshooting.

How To Use ModHotReloader#

1. Create a new mod project via Red Mod Manager.
2. Add the Directory.Build.props file to your project:
   <Project><PropertyGroup><DisableCopyToGame>True</DisableCopyToGame></PropertyGroup></Project>
3. Configure the settings to point to the new mod, ensuring the DLL name and path are correct.
4. Load up the game.
5. Verify the mod is loaded via Unity Explorer Log.
6. Add a method to your mod that prints to the log:
   
   private void HelloWorld() {
RLog.Msg("Hello From Your Mod!");
}
7. Rebuild the mod project while the game is running. The hot reloader will detect changes and reload the mod.
8. Check Unity Explorer Log to confirm the mod was reloaded.
9. Add a breakpoint to the method. Attach your debugger using Unity Explorer.
10. Invoke the method using InvokeMethodWithinHotLoadedMod HelloWorld and check the log for your message.