RisingV.Shared 0.1.0

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

Common utilities and building-blocks for every other RisingV mod. This library provides a set of APIs and utilities that make it easier to create and manage mods for V Rising. Does not depend on any other RisingV mod, so it can be used standalone.

“RisingV.Shared is a shared 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

• Event bus – decoupled, async pub-sub pipeline for game-wide events.
• Engine modules – modular architecture for loading/unloading systems, processors and hooks.
• Config base – hot-reloadable config manageable class with type-safe access.
• Custom collections – generic collections like TypeKeyedMap<T>, TimestampedMap<K,V>, etc.
• Common game data - type-safe wrappers for V Rising game data like Territory, BuffData, etc.
• Database abstraction – a database API for storing and retrieving data, with support for JSON or Maps.
• Comprehensive extensions – Class extensions for common operations on Entity, collections, strings, and more.
• File system observers – watch for file changes with a simple API.
• Manager abstraction – a base class for managing game objects with automatic object management with a lifecycle.
• Plugin base API – a base class for creating BepInEx plugins with a managed lifecycle.
• Prefab data – type-safe access to prefab data like Item, Effect, etc.
• Processor system – a high-level abstraction for processing game objects/events in a type-safe manner.
• Strings and localization – a simple string localization system with support for multiple languages.
• Systems – a high-level abstraction for creating and managing systems for use in RisingV mods.
• Logging facade – a unified logging interface with support for tagging and levels.
• Reflection utilities – type-safe reflection helpers for dynamic type access.
• Networking helpers – thin sugar over Stunlock.Network for RPCs & sync vars.
• Utilities – various utility classes for common tasks.

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

Installation

dotnet add package RisingV.Shared

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

1. Prerequisites
   • V Rising (vanilla game/dedicated server installed)
   • BepInEx (version compatible with your V Rising installation)
2. Build/Download
   • Clone or download the latest RisingV.Shared DLL from this repository’s Releases.
3. Deploy
   • Copy RisingV.Shared.dll to ...\BepInEx\plugins\RisingV\.
   • Restart V Rising (or reload BepInEx plugins) so that the Shared assembly is loaded before any other RisingV-based mod.

Quick start

// Added to your plugin class
[BepInDependency("RisingV.Shared")]

Configurations

RisingV.Shared.Config has a base class configuration management class BaseConfig. 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. It also means that majority of the systems/components in the RisingV ecosystem can be configured via json files.

BepInEx/configs
└── RisingV.Shared
   └── RisingV.Shared.cfg

Documentation

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

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.