RisingV.Scripting 0.1.1

<a href="https://risingv.dev"><p align="center"><img src="https://risingv.dev/images/scripting-logo.png" width="450" alt="RisingV.Scripting" /></p></a>

Hot-reloadable C# scripting for live mod prototyping for RisingV.

“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.”

Features

• Live reload – iterate on scripts without restarting the server
• Sandboxing – executes inside a limited AppDomain with whitelisted assemblies
• Diagnostics – real-time console & overlay logging for script errors
• Command execution – run C# code from the in-game chat commands using .script run <code>

Note: This may not be the entire list—refer to the API docs for every class, interface, and extension method that RisingV.Scripting provides.

Installation

dotnet add package RisingV.Shared RisingV.Scripting 

Or drop the compiled RisingV.Shared.dll, RisingV.Scripting.dll into your BepInEx /plugins/RisingV folder.

Getting started

// 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.

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 uses the RisingV.Shared.Config base class for configuration management. This allows you to define your plugin's configuration in a type-safe manner, with support for hot-reloading and easy access to configuration values.

BepInEx/configs
└── RisingV.Scripting
    └── Engines
        └── ScriptingEngine.cfg

Documentation

For a deeper dive, API reference, and design docs see https://docs.risingv.dev/scripting.

Contributing

PRs that add new functionality—or improve existing ones—are warmly welcomed. Please open an issue first if you plan a large refactor.

License

GNU GPL-3.0. See LICENSE for details.