If you feel like this guide is missing something or has some incorrect information. Feel free to let us know by email or on the discord server. If you know how to fix the issue, feel free to improve these docs with a merge request here!
Creating your first mod!
This text guide will show you the up to date method on how to create a basic mod for VTOL VR using the mod loader at vtolvr-mods.com.
In this guide, we will go through the process of installing the software you need, creating the project, writing the code and testing it in the game.
Modding in VTOL VR isn't supported by the developer, so there are a few differences to native modding games. Mods for VTOL VR consist of a Class Library in the .NET Framework. The Mod Loader searches these Class Libraries for a class called
VTOLMOD. Then once that is found, it will create a new GameObject with do not destroy on load set to it (so it persists between scenes) and adds your
VTOLMOD class onto that then calls
If you have anymore questions about the process of creating a mod . Here are some useful places to get answers.
The modding Discord is a great place to get specific questions answered. You can chat with current mod creators and with the general community who like playing with mods.
We are small though so don't feel ignored if you don't get a response right away.
If you haven't guessed already, VTOL VR is created in Unity, the Unity Docs are well documented explaining what each function does and how to use it. You don't have to use 2019.1 docs as not much has changed from the version VTOL VR uses to the latest version.
If you want to tweak existing code like stopping a method in the game from running or fetching a private variable, Harmony has got you covered!
This is the documentation for Harmony 220.127.116.11 (the version we use) and it will explain the basics of using Harmony.