Add Load(Action<IPlugin> onLoading) and update README

Author: BenDol

README.md

@@ -5,8 +5,8 @@
 
 Hot-reloadable C# scripting for live mod prototyping for [RisingV](https://risingv.dev).
 
-> *“[RisingV.Scripting](https://github.com/RisingV-Mods/RisingV.Scripting) is a core mod for V Rising that allows you to use RisingV mods.  
-> It provides a set of APIs and utilities that make it easier to create and manage mods for V Rising.”*
+> *“[RisingV.Scripting](https://github.com/RisingV-Mods/RisingV.Scripting) is a scripting mod for V Rising that allows you to write reloadable scripts in a sandboxed domain.  
+> It only depends on RisingV.Shared so does not need to be run from a core plugin.”*
 
 ## Features
 - **Live reload** – iterate on scripts without restarting the server
@@ -29,59 +29,82 @@ dotnet add package RisingV.Scripting
 ```
 
 ## Getting started
-```csharp
-// Added to your plugin class
-[BepInDependency("RisingV.Scripting")]
-```
-
-Creating a new script is as simple as creating a new C# file in the `BepInEx/config/<YOURMOD_GUID>/Scripts` directory.
-```csharp
-using RisingV.Scripting.Managers;
-using RisingV.Scripting.RuntimeHost;
-using RisingV.Shared.Logging;
-using RisingV.Shared.Managers;
-using RisingV.Shared.Plugins;
-
-// Optional (namespace should match the plugin namespace or remove this line)
-namespace RisingV.Scripting.Tests;
-
-/// <summary>
-/// Sample script for testing purposes to demonstrate how it can be used.
-/// </summary>
-/// <param name="context">The script context containing the script data.</param>
-public class SampleScript(IScriptContext<ScriptData> context) : Script(context), IReloadableScript
-{
-    public override void Initialize(ScriptManager manager, List<IPlugin> plugins)
-    {
-        Log.Info("SampleScript initialized.");
-        // Called then the plugin is initializing, before any scripts are loaded.
-    }
-
-    public override void Load(ScriptManager manager, List<IPlugin> plugins)
-    {
-        Log.Info("SampleScript loaded.");
-        // Called when the Shared Components are loading, after the plugin is initialized.
-    }
-
-    public override void Unload(ScriptManager manager, List<IPlugin> plugins)
-    {
-        Log.Info("SampleScript unloaded.");
-        // Called when the Shared Components are unloading and before the plugin is terminated or reloading.
-    }
-
-    public override void Terminate(ScriptManager manager, List<IPlugin> plugins)
-    {
-        Log.Info("SampleScript terminated.");
-        // Called when the plugin is being terminated, after all scripts are unloaded.
-    }
-
-    public override void Reload(ScriptManager manager, List<IPlugin> plugins, ReloadReason reason)
-    {
-        Log.Info("SampleScript reloaded. Reason: " + reason);
-        // Called when the script is being reloaded, e.g. due to a change in the script file.
-    }
-}
-```
+1. Add the `RisingV.Scripting` dependency to your plugin class to enable scripting support:
+   ```csharp
+   // Added to your plugin class
+   [BepInDependency("RisingV.Scripting")]
+   ```
+2. Add the `ScriptingEngine` to your plugin's `Initialize` method:
+   ```csharp
+   public override void OnInitialize()
+   {
+       EngineManager.AddEngine<ScripingEngine>();
+   }
+   ```
+   or, if you aren't using the RisingPlugin base class you can add the engine directly:
+   ```csharp
+   [BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
+   [BepInDependency("RisingV.Scripting")]
+   public class Plugin : BasePlugin
+   {
+       public override void Load()
+       {
+           Bootstrap.Load(p => {
+               var engineManager = Bootstrap.SharedComponents.Get<EngineManager>();
+               engineManager!.AddEngine<ScriptingEngine>(p);
+           });
+       }
+   }
+   ```
+
+3. Creating a new script is as simple as creating a new C# file in the `BepInEx/config/<YOURMOD_GUID>/Scripts` directory.
+   ```csharp
+   using RisingV.Scripting.Managers;
+   using RisingV.Scripting.RuntimeHost;
+   using RisingV.Shared.Logging;
+   using RisingV.Shared.Managers;
+   using RisingV.Shared.Plugins;
+   
+   // Optional (namespace should match the plugin namespace or remove this line)
+   namespace RisingV.Scripting.Tests;
+   
+   /// <summary>
+   /// Sample script for testing purposes to demonstrate how it can be used.
+   /// </summary>
+   /// <param name="context">The script context containing the script data.</param>
+   public class SampleScript(IScriptContext<ScriptData> context) : Script(context), IReloadableScript
+   {
+       public override void Initialize(ScriptManager manager, List<IPlugin> plugins)
+       {
+           Log.Info("SampleScript initialized.");
+           // Called then the plugin is initializing, before any scripts are loaded.
+       }
+   
+       public override void Load(ScriptManager manager, List<IPlugin> plugins)
+       {
+           Log.Info("SampleScript loaded.");
+           // Called when the Shared Components are loading, after the plugin is initialized.
+       }
+   
+       public override void Unload(ScriptManager manager, List<IPlugin> plugins)
+       {
+           Log.Info("SampleScript unloaded.");
+           // Called when the Shared Components are unloading and before the plugin is terminated or reloading.
+       }
+   
+       public override void Terminate(ScriptManager manager, List<IPlugin> plugins)
+       {
+           Log.Info("SampleScript terminated.");
+           // Called when the plugin is being terminated, after all scripts are unloaded.
+       }
+   
+       public override void Reload(ScriptManager manager, List<IPlugin> plugins, ReloadReason reason)
+       {
+           Log.Info("SampleScript reloaded. Reason: " + reason);
+           // Called when the script is being reloaded, e.g. due to a change in the script file.
+       }
+   }
+   ```
 The script will be automatically compiled and loaded by the Scripting Engine. Make sure the script is marked with `IReloadableScript` interface to enable hot-reloading.
 
 ## Configurations

RisingV.Scripting/Plugin.cs

@@ -27,12 +27,12 @@ public class Plugin : BasePlugin
 
     public override void Load()
     {
-        Log.Info($"Plugin {MyPluginInfo.PLUGIN_GUID} version {MyPluginInfo.PLUGIN_VERSION} is loaded!");
+        Log.Debug($"Plugin {MyPluginInfo.PLUGIN_GUID} version {MyPluginInfo.PLUGIN_VERSION} is loaded!");
     }
 
     public override bool Unload()
     {
-        Log.Info($"Unloading Plugin {MyPluginInfo.PLUGIN_GUID} version {MyPluginInfo.PLUGIN_VERSION}");
+        Log.Debug($"Unloading Plugin {MyPluginInfo.PLUGIN_GUID} version {MyPluginInfo.PLUGIN_VERSION}");
         return base.Unload();
     }
 }