Hamunii-AutoReload icon

AutoReload

Automatically reloads plugins by watching BepInEx/plugins/ for file changes. For developers.

Last updated 2 days ago
Total downloads 82
Total rating 1 
Categories Tools Quality Of Life Client Side
Dependency string Hamunii-AutoReload-1.0.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_PEAK-5.4.2403 icon
BepInEx-BepInExPack_PEAK

BepInEx pack for PEAK. Preconfigured and ready to use.

Preferred version: 5.4.2403

README

AutoReload

A BepInEx 5 plugin that automatically reloads plugins by watching BepInEx/plugins/ for file changes.

[!WARNING]
I have been informed that the FileSystemWatcher may work terribly on Windows. This plugin relies on FileSystemWatcher working properly. If you are having issues with it, try running under Linux.

Implementing Support

To make your plugin work with reloading, it must implement the OnDestroy method in the main plugin class to clean up after itself. An example of a good plugin:

[BepInAutoPlugin]
public partial class Plugin : BaseUnityPlugin
{
    void Awake()
    {
        // Apply all hooks
        MonoDetourManager.InvokeHookInitializers(typeof(Plugin).Assembly);
        Log.LogInfo($"Plugin {Name} is loaded!");
    }

    void OnDestroy()
    {
        // Dispose all hooks
        DefaultMonoDetourManager.Instance.Dispose();
        Log.LogInfo($"Plugin {Name} unloaded!");
    }
}

[!TIP]
The above plugin uses Hamunii.BepInEx.AutoPlugin for the [BepInAutoPlugin] attribute.

Credits

This is a hard fork of BepInEx.Debug ScriptEngine which dramatically changes how the plugin works.

Main changes are:

  • scripts/ directory is gone
    • assemblies are reloaded from plugins/
    • LoadOnStart option is gone
  • FileSystemWatcher option is gone, always enabled
    • AutoReloadDelay option is gone
    • ReloadKey option is gone
    • IncludeSubdirectories option is gone, always enabled
    • Only "file changed" and "file renamed" events are listened to
  • DumpAssemblies option is gone, always enabled
    • This is because you can get debug symbols this way