Modding:Content Tutorial Simple Item: Difference between revisions

From Vintage Story Wiki

Modding:Content Tutorial Simple Item (view source)

Revision as of 16:22, 21 March 2024

306 bytes added ,  1 month ago
m
Intro and navigation.
(Created "Simple Item Tutorial" page)
 
m (Intro and navigation.)
Line 3: Line 3:
{{GameVersion|1.19.4}}
{{GameVersion|1.19.4}}
__FORCETOC__
__FORCETOC__
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 ==
== Introduction ==


=== Objective ===
=== 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.)'''
In this tutorial, you will create an item - A simple wand! Although this item will have no real functionality, it will demonstrate how to create assets in json, as well as how to use shapes, textures, and lang files.


=== Assets ===
=== Assets ===
'''(Add Links)'''
Before starting, it is recommended you [https://github.com/Nateonus/vsmodexamples/releases/tag/SimpleItemTutorial download the workspace and assets] for this tutorial. The completed files can also be found here.


Before starting, it is recommended you download the workspace and assets for this tutorial.
This tutorial starts with the following assets:
 
This tutorial starts with the following assets: '''(Edit as needed.)'''


* Mod Setup & Folder Structure
* Mod Setup & Folder Structure
Line 23: Line 19:
* Item shape file
* Item shape file
* Item texture file
* Item texture file
The finished tutorial files can be found here.


=== Prerequisites ===
=== Prerequisites ===
'''(Add prerequisite knowledge and links if appropriate.)'''
This tutorial will assume you understand the following topics:
This tutorial will assume you understand the following topics:


== Adding an Item ==
* [[Modding:Developing a Content Mod|Setting up a content mod.]]
'''(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.)'''
* [[Modding:Content Tutorial Basics|The functions of shape, texture and lang files.]]
 
=== Creating our Item ===


=== Testing our Item ===
== Navigating Assets ==
Using the downloaded workspace, have a look at the files that currently exist.


=== Try it out... ===
* ''modinfo.json'' - The mod info file, which registers your mod with the ID 'simpleitem'.
* ''modicon.png'' - The mod icon file, which will be displayed on the mod manager menu.
* ''assets/simpleitem/itemtypes/simplewand.json'' - An empty file, this is where you shall put the code for your item.
* ''assets/simpleitem/lang/en.json'' - A sample language file, which is where you will add your translation values.
* ''assets/simpleitem/shapes/item/simplewand.json'' - A shape file for the wand.
* ''assets/simpleitem/textures/item/simplewand.png'' - A texture file for the wand.


== Conclusion ==
== Conclusion ==
Nateonus
Confirmedusers
536

edits

Retrieved from "https://wiki.vintagestory.at/index.php/Special:MobileDiff/174128"