Modding:Creating A Code Mod

This page was last verified for Vintage Story version 1.19.8.

Prerequisites

Before creating a code mod, you need to have completed the Preparing For Code Mods tutorial. This will show you how to setup your development environment, install dotnet, and install the modding template. If you have done that, you can carry on with this tutorial.

This tutorial is suitable for modders using Visual Studio. If you have chose to use a different IDE, please refer to the older Setting up your Development Environment tutorial.

Recommended Knowledge

Before continuing, it is highly advisable to have some knowledge of Visual Studio and the C# programming language. These topics are out of the scope of this tutorial, however if you can understand the following tutorials, you should be okay:

• Starting with Visual Studio (YouTube)
• Create a .NET console application using Visual Studio (Microsoft.com)

Creating a New Mod

To create a new code mod, launch Visual Studio, and select 'Create a new project'. In the create menu, select Vintage Story from the dropdown furthest to the right. This will filter the list of templates, to only show ones with the "Vintage Story" project type.

Select the 'Vintage Story Basic Mod Template'. This will load a new menu asking for a project name, location, and solution name.

Your project name should follow these requirements:

• Not contain any spaces or punctuation.
• Be formatted in PascalCase.
• Not be abbreviated (MyFirstMod instead of MFM).

Your project name will also determine your Mod ID, however this can be altered later. Your mod id will be converted to all lower case.

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.