Skip to content

shaun-wild/VRising-Starter-Project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

V-Rising Starter Project

A super simple bare-bones project with Vampire Command Framework , Wetstone and Harmony pre-setup.

Getting started

Rename project

  • Rename VRisingStarterProject.csproj to your project name.
  • perform a project-wide search and replace for VRisingStarterProject and replace it with your project name.
  • Rename the root folder of this project to your project name.

Setup Auto-Configuration

This project is automatically configured to use VCF on the server and Wetstone on the client, you can decide which of these you would like to use by modifying YourProjectName.csproj.

  1. Update the <VRisingBasePath> property, this should point to your V-Rising base path.
  2. Set the <ModType> property, this can either be Server or Client.
  3. Update the VCF, Wetstone and Harmony properties to either true or false, depending on whether you'd like them or not.

Dependencies

Dependency Description Mod type
VCF Vampire Command Framework, supports hot reloading and has an easy-to-use API for issuing server commands. Server
Wetstone Wetstone is used for its hot reloading on the client, as well as providing some useful utilities Server, Client
Harmony Harmony is a powerful plugin, allows for patching and hooking into methods. Server, Client

Final Steps

Update this README to better suit your project, if you're open sourcing then make sure to include a nice README!

Todos

  • Remove the binaries in lib in favour of a better solution.

Contributing

If you would like to modify this starter project, then fork this repository and open a pull-request.

Made with ♥ by Shaun#3052.

Join the V-Rising modding discord?

About

My VRising starter project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages