Modding:Tutorial Template

From Vintage Story Wiki
Other languages:

This page was last verified for Vintage Story version 1.19.4.


This page is a template for modding tutorials. To enhance readability and make modding a smoother experience, each tutorial should use the same or similar headings based on this page. Copy and paste this page's source in order to clone it.

Introduction

Objective

In this tutorial, you will (Add objective. Tutorials should only achieve one topic at a time, and not be too complex. If you have multiple complexities, split these into multiple tutorials.)

Assets

(Add Links)

Before starting, it is recommended you download the workspace and assets for this tutorial.

This tutorial starts with the following assets: (Edit as needed.)

  • Mod Setup & Folder Structure
  • Empty item file
  • Template lang file
  • Item shape file
  • Item texture file

The finished tutorial files can be found here.

Prerequisites

(Add prerequisite knowledge and links if appropriate.)

This tutorial will assume you understand the following topics:

Adding an Item

(The above heading is counted as a 'step'. I recommend following a method of 'do', 'analyse', 'experiment' for each step to improve modder's knowledge and understanding.)

Creating our Item

Testing our Item

Try it out...

Conclusion

Congratulations, you have now (created your first item...)! This tutorial should have given you some understanding of (blah blah blah).

Next Steps...

Try out the next tutorial, (link). This will show you how to create a (...)!


Content Modding
Basics Content Mods Developing a Content Mod Packaging & Release
Tutorials
Concepts Modding Concepts Modinfo Variants Domains Patching Remapping World Properties
Moddable Assets
Uncategorized
Icon Sign.png

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.

Modding
Modding Introduction Getting Started Theme Pack
Content Modding Content Mods Developing a Content Mod Basic Tutorials Intermediate Tutorials Advanced Tutorials Content Mod Concepts
Code Modding Code Mods Setting up your Development Environment
Property Overview ItemEntityEntity BehaviorsBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity BehaviorsCollectible BehaviorsWorld properties
Workflows & Infrastructure Modding Efficiency TipsMod-engine compatibilityMod ExtensibilityVS Engine
Additional Resources Community Resources Modding API Updates Programming Languages List of server commandsList of client commandsClient startup parametersServer startup parameters
Example ModsAPI DocsGitHub Repository