Skip to content

Latest commit

 

History

History
140 lines (94 loc) · 7.72 KB

troubleshooting.md

File metadata and controls

140 lines (94 loc) · 7.72 KB

Troubleshooting ResoniteModLoader

Below we will go over some common problems and their solutions.

ResoniteModLoader Isn't Being Loaded

Symptoms:

  • After starting the game nothing has changed, and it appears completely unmodified.
  • Logs don't say anything about "ResoniteModLoader"

Fix:

If the problem is the -LoadAssembly setup:

  1. Check the logs (C:\Program Files (x86)\Steam\steamapps\common\Resonite\Logs). If you search the log for "ResoniteModLoader" you should find a section that looks like this:

     2:12:22 AM.869 ( -1 FPS)   Computing compatibility hash...
 2:12:22 AM.872 ( -1 FPS)   Loaded Extra Assembly: Libraries/ResoniteModLoader.dll
 2:12:22 AM.874 ( -1 FPS)   Compatibility Hash: pkJrcwZuU9k9oRlXT/DANw

    If those logs are absent it indicates you are not passing the -LoadAssembly Libraries/ResoniteModLoader.dll argument to Resonite correctly.

  2. Double check your shortcut to Resonite.

  3. If you have ResoniteModLoader.dll in a different folder than Libraries, you will likely need to use the absolute path like -LoadAssembly "C:\Program Files (x86)\Steam\steamapps\common\Resonite\Libraries\ResoniteModLoader.dll"

    • Absolute paths need to be surrounded with quotation marks if they include any spaces ""

  4. Check a known-working shortcut.

    1. Navigate to the Resonite install directory. (C:\Program Files (x86)\Steam\steamapps\common\Resonite)
    2. Create a new text file named start_resonite.bat in your Resonite install directory. Make sure the file extension is .bat and not .txt.
    3. Copy the contents of the example start_resonite.bat into yours.
    4. Run your start_resonite.bat by double-clicking it in your file explorer.
    5. Resonite should start and load ResoniteModLoader as expected.

If the problem is the FrooxEngine.dll path on Linux:

  1. If you are on Linux, make sure you've followed the extra Linux instructions.

Windows may be blocking the DLL files from being loaded:

(Provided example from windows Headless)

[ERROR][ResoniteModLoader] Error loading assembly from C:\Program Files (x86)\Steam\steamapps\common\Resonite\Headless\rml_libs\0Harmony.dll: System.IO.FileLoadException: Could not load file or assembly 'file:///C:\Program Files (x86)\Steam\steamapps\common\Resonite\Headless\rml_libs\0Harmony.dll' or one of its dependencies. Operation is not supported. (Exception from HRESULT: 0x80131515)
File name: 'file:///C:\Program Files (x86)\Steam\steamapps\common\Resonite\Headless\rml_libs\0Harmony.dll' ---> System.NotSupportedException: An attempt was made to load an assembly from a network location which would have caused the assembly to be sandboxed in previous versions of the .NET Framework. This release of the .NET Framework does not enable CAS policy by default, so this load may be dangerous. If this load is not intended to sandbox the assembly, please enable the loadFromRemoteSources switch. See http://go.microsoft.com/fwlink/?LinkId=155569 for more information.
  1. Right click on the ResoniteModLoader.dll file and open the properties.
  2. Check the unblock checkbox, and hit OK.
    unblock dll on windows
  3. Repeat this process for 0Harmony.dll.

If the problem is your antivirus:

  1. Make sure your antivirus has not quarantined or deleted ResoniteModLoader.dll or 0Harmony.dll.
  2. Add an exception to your antivirus. If you're uncomfortable adding an exception, you have options:
    • Don't run ResoniteModLoader.
    • Change to an antivirus that has fewer false positives.
    • Build ResoniteModLoader and/or Harmony yourself from source code.

ResoniteModLoader Loads, but Errors Out

Symptoms:

  • Mods are not loading
  • All of your contacts appear to be on the same version as you but showing the current versions such as On Version 2023.9.26.304
  • All of your contacts appear to be using an incompatible version

Fix:

  1. Verify that the installation instructions were followed correctly
  2. If you are using Linux builds, make sure you've followed the extra steps.
  3. Check the logs (C:\Program Files (x86)\Steam\steamapps\common\Resonite\Logs). There are a few things you are likely to find:

Possibility 1: Harmony is not installed correctly.

  1. Your log contains the following:

     2:04:54 AM.013 ( -1 FPS)   [ERROR][ResoniteModLoader] Exception in execution hook!
 System.IO.FileNotFoundException: Could not load file or assembly '0Harmony, Version=2.2.2.0, Culture=neutral, PublicKeyToken=null' or one of its dependencies.
 File name: '0Harmony, Version=2.2.2.0, Culture=neutral, PublicKeyToken=null'
   at ResoniteModLoader.ExecutionHook..cctor () [0x00050] in <86a5d715b5ea4079ac09deb2b6184e56>:0

  2. Go back to the installation instructions and install Harmony to the correct location.

Possibility 2: You are using an old version of ResoniteModLoader.

  1. Check your log for a line like this:
3:45:43 AM.373 ( -1 FPS) [INFO] [ResoniteModLoader] ResoniteModLoader v2.4.0 starting up!
  1. Verify your ResoniteModLoader version matches the latest release.

Possibility 3: ResoniteModLoader itself is broken, even on the latest version. This can happen in rare circumstances when Resonite updates.

  1. Please report the issue on our Discord or in a GitHub issue.
  2. Wait for a fix.

Multiplayer Compatibility is Broken, but Everything Else Works

Symptoms:

  • Mods are loading
  • All of your contacts appear to be on the same version as you but showing the current versions such as On Version 2023.9.26.304
  • All of your contacts appear to be using an incompatible version

Fix:

  1. Make sure you are not running more than one plugin. For safety reasons, ResoniteModLoader will only spoof your version if it is the only plugin running.
  2. If you absolutely need your other plugin and understand the risks there is a configuration available to force version spoofing.

A Mod is Breaking Resonite

Symptoms:

  • Modded Resonite is broken or crashing unexpectedly
  • Unmodified Resonite is working

Fix:

Remove the offending mod, and contact its developer so they can fix the bug.

If you are not sure which mod is broken, follow the below steps:

  1. Check the logs (C:\Program Files (x86)\Steam\steamapps\common\Resonite\Logs). They should indicate which mod is failing. If the logs don't help, then continue with the following steps.
  2. Disable ResoniteModLoader by removing the -LoadAssembly Libraries/ResoniteModLoader.dll launch option. If Resonite is still having problems while completely unmodified, you can get support on the Resonite Discord. You should not ask the Resonite Discord for help with mods.
  3. If you only experience the problem while modded, try uninstalling all of your mods and re-installing them one by one. Once you find the problematic mod reach out it its developers.
  • Alternatively you can re-add mods half at a time until the problem starts occuring then investigate within the smaller set of mods.
  1. If the issue appears to be with ResoniteModLoader itself, please open an issue.

I Need More Help

If you are having trouble diagnosing the issue yourself, we have a #help-and-support channel in the Resonite Modding Discord. The first thing we're likely to ask for is your log, so please have that handy. You can find logs here: C:\Program Files (x86)\Steam\steamapps\common\Resonite\Logs