Modding:Code Tutorial Essentials: Difference between revisions

From Vintage Story Wiki
mNo edit summary
Line 3: Line 3:
This page will give a breakdown of a number of topics and terminology used with code modding. Since some code topics can become quite complex, it is important to read through this page.
This page will give a breakdown of a number of topics and terminology used with code modding. Since some code topics can become quite complex, it is important to read through this page.


This page will also introduce you to the coding tutorials and how they work.  
This page will also introduce you to the coding tutorials and how to begin with them.
 
== Modding Tutorials ==
All tutorials within the categorized sections (basic, intermediate, advanced, other) can be made in the same project as one another. All tutorials are created under the project name "VSTutorial". It is recommended to [[Modding:Creating A Code Mod|create a new mod]] with the same project name, and use this project when you wish to complete any tutorial.
 
When writing code, it's important to keep your code well-organized and documented. Coding styles vary from person to person, however the tutorials will always prefer readability and understandability over efficiency. If there are instances of more efficient code, these may be mentioned at the time.


== Client/Server ==
== Client/Server ==
Line 13: Line 18:


== Mod System ==
== Mod System ==
A '''Mod System''' is used entry point for your mod, and contains many useful functions for the execution of your mod. A single mod can have multiple mod systems, but must have at least one for any code to be executed.  
A '''Mod System''' is used as an entry point for your mod, and contains many useful functions for the execution of your mod. A single mod can have multiple mod systems, but must have at least one for any code to be executed.  


When creating a mod using the mod template, you will notice that a mod system is automatically generated with a number of functions.
When creating a mod using the mod template, you will notice that a mod system is automatically generated with a number of functions.