Modding:Creating A Code Mod: Difference between revisions

From Vintage Story Wiki
(Created page with "<languages/> {{GameVersion|1.19.8}} __FORCETOC__ <translate>This page is in progress. </translate> {{Navbox/codemodding}}")
 
mNo edit summary
(One intermediate revision by the same user not shown)
Line 3: Line 3:
__FORCETOC__
__FORCETOC__


<translate>This page is in progress.
<translate>
== Prerequisites ==
Before creating a code mod, you need to have completed the [[Modding:Preparing For Code Mods|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 [[Modding:Setting up your Development Environment|Setting up your Development Environment]] tutorial.'''
 
=== Recommended Knowledge ===
It is highly advisable to have some knowledge of Visual Studio and the C# programming language before creating code mods. These are out of the scope of this tutorial, however If you can understand the following tutorials, you should be okay:
 
* [https://www.youtube.com/watch?v=iC3CJcYxkl0 Starting with Visual Studio (YouTube)]
* [https://learn.microsoft.com/en-gb/dotnet/core/tutorials/with-visual-studio?pivots=dotnet-7-0 Create a .NET console application using Visual Studio (Microsoft.com)]
</translate>
</translate>
{{Navbox/codemodding}}
{{Navbox/codemodding}}

Revision as of 15:34, 22 May 2024

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

It is highly advisable to have some knowledge of Visual Studio and the C# programming language before creating code mods. These are out of the scope of this tutorial, however If you can understand the following tutorials, you should be okay:

Code Modding
Basics Code Mods Preparing For Code Mods Creating A Code Mod
Tutorials
Advanced Server-Client Considerations Setting up your Development Environment Advanced Blocks Advanced Items Block and Item Interactions Block Behavior Block Entity Particle Effects World Access Inventory Handling Commands GUIs Network API Monkey patching (Harmony)
Data Management VCDBS format Savegame Moddata ModConfig File Chunk Moddata Serialization Formats TreeAttribute
Worldgen WorldGen API NatFloat EvolvingNatFloat
Rendering Shaders and Renderers
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 ItemEntityBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity 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