VAMP

V Rising API Modding Platform

VAMP is a comprehensive modding framework for V Rising, providing developers with powerful tools to create and modify game content. VAMP offers a structured API to interact with game systems, entities, prefabs, and more, enabling the creation of complex mods that enhance gameplay experiences.

Features

• Entity Management: Easily create, modify, and manipulate game entities
• Player Interaction: Access player data, inventory, equipment, and status
• World Manipulation: Work with world zones, territories, and positions
• Prefab System: Utilize the extensive collection of game prefabs for NPCs, abilities, and items
• Castle Management: Interface with castle hearts and territories
• Unit Customization: Create and modify units like horses, NPCs, and monsters
• EventScheduler: A global manager for running event mods
• FileReload: A system for automatically reloading files without server restart
• WipeData: A system for resetting mods automatically for server wipe
• ModTalk: A simple low-friction system for inter-mod communication
• ModSystem: Automatic notification of mod updates on Thunderstore
• ChatUtil: An extension of the System Chat System
• ModProfiler: A system for profiling mod performance (use it if your server is lagging and don't know why!)
• And more...

The original intention for this mod was to stop copy-pasting a large amount of code between projects, especially files like ECSExtensions and Core. Then it expanded from there to include systems that were used in a majority of my CrimsonMods. Now it has been standardized and documented for use by other modders to make modding V Rising easier and more accessible.

The API is very much still a work in progress and will likely change a bit over time as I continue to use it and add more features.

Getting Started

If you're simply a player:

• Install the version of BepInEx that is defined in the Dependencies.
• Extract VAMP.dll into (Game/Server Folder)/BepInEx/plugins

If you're a developer: VAMP is available as a NuGet package for easy integration into your projects

dotnet add package VRising.VAMP

Or add it directly to your project filee:

Resources

API Documentation

Modding Discord & Support

GitHub Repository

NuGet Package

Contributing

We welcome contributions from the community! If you'd like to contribute to VAMP, please join the discord server and join the conversation in the VAMP channel.

NuGet publishing

The build workflow publishes VRising.VAMP to nuget.org on pushes to master using Trusted Publishing. Before publishing, a package owner must:

1. Create a trusted publishing policy on nuget.org for the package owner, with repository owner SkyTech6, repository VAMP, and workflow file build.yml. Leave the environment empty and allow publishing new versions of VRising.VAMP.
2. Set the GitHub Actions secret NUGET_USER to the nuget.org username for the policy owner (not an email address).
3. After confirming a successful trusted publish, revoke the old NuGet API key and remove the NUGET_KEY GitHub secret.

Support

Want to support my modding development?

Buy / Play My Games!

Free to Plays

<img src="https://coinandpike.c