Modding:Getting Started: Difference between revisions

From Vintage Story Wiki
Marked this version for translation
(Add a section for how to search the modding pages)
(Marked this version for translation)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/><translate>
<languages/><translate>
<!--T:1-->
<!--T:1-->
{{GameVersion|1.15}}
{{GameVersion|1.19.6}}


<!--T:2-->
<!--T:2-->
Vintage story has an extensive modding system built into the game, allowing any user to make their own changes and additions as they see fit.
Vintage story has an extensive modding system built into the game, allowing any user to make their own changes and additions as they see fit.
<!--T:3-->
For an overview of the game's modding system and philosophy, refer to the [https://www.vintagestory.at/features/modding.html/ Modding] page on the Vintage Story website.


<!--T:4-->
<!--T:4-->
Line 15: Line 12:
__TOC__
__TOC__


== Searching the wiki ==
== Searching the wiki == <!--T:18-->
By default the wiki's search feature excludes the modding pages. To search the modding pages, one option is to search for the term with the main search box at the top of the page, then click the 'everything' link on the search results tab.
By default the wiki's search feature excludes the modding pages. To update your search preferences, click the "Search Modding" button below. The results page will show that the (Main), BlockJson, and Modding namespaces are checked. Check "Remember selection for future searches", then click search to save the changes.


Another option is to use the search modding box in the navbox at the bottom of the page.
<!--T:19-->
{{#tag:inputbox|
type=search
namespaces=Main**,Modding**,BlockJson**
break=no
width=40
searchbuttonlabel=Search Modding
}}


== What Mods can I make? == <!--T:6-->
== What Mods can I make? == <!--T:6-->


<!--T:7-->
<!--T:7-->
The current modding system for Vintage Story is incredibly flexible and quite easy to use even if you don't know how to program. You can add fully functional '''blocks''', '''items''' and even '''entities''' into the game without ever opening an [https://en.wikipedia.org/wiki/Integrated_development_environment IDE]. Although it is recommended you learn how to use one if you plan on modding a lot in the future, as they are very convenient.  
The current modding system for Vintage Story is incredibly flexible and quite easy to use even if you don't know how to program. You can add fully functional '''blocks''', '''items''' and even '''entities''' into the game without ever opening an [https://en.wikipedia.org/wiki/Integrated_development_environment IDE]. More complex changes and systems can be made using C# programming.


<!--T:8-->
<!--T:8-->
This is because nearly every feature of the game relies on the usage of '''JSONs''', which are text documents that utilize a flexible, easy to read format. You can open these files with any text editor, and with just a little bit of practice you can learn how to format them to avoid errors. The best way to learn this is to study the existing JSONs that are visible to anybody who has the game installed. To do so you'll need to locate the Vintage Story Assets folder, which you can learn about at the '''[[Modding:The Asset System | Asset System]]''' page. <br> In addition, here is a [https://www.youtube.com/watch?v=iiADhChRriM 12 minute video] that will teach you why json is used, and the basic syntax, making it easier to understand the rest of the documentation.
This is because nearly every feature of the game relies on the usage of '''JSONs''', which are text documents that utilize a flexible, easy to read format. You can open these files with any text editor, and with just a little bit of practice you can learn how to format them to avoid errors. The best way to learn this is to study the existing JSONs that are visible to anybody who has the game installed. To do so you'll need to locate the Vintage Story Assets folder, which you can learn about at the '''[[Modding:Asset System |Asset System]]''' page. <br>In addition, here is a [https://www.youtube.com/watch?v=iiADhChRriM 12 minute video] that will teach you why json is used, and the basic syntax, making it easier to understand the rest of the documentation.


<!--T:9-->
<!--T:9-->
Line 44: Line 48:


<!--T:14-->
<!--T:14-->
If you're just starting out it is certainly best to begin with a content mod, as most code mods simply extend the features of blocks, items and entities made from a content mod anyway. Once you've mastered content mods you can move onto coding if you want to add some really special things to your Vintage Story experience.
If you're just starting out, it's best to begin with a content mod, as most code mods simply extend the features of blocks, items and entities made from a content mod anyway. Once you've mastered content mods you can move onto coding if you want to add some really special things to your Vintage Story experience.


<!--T:15-->
<!--T:15-->
Line 50: Line 54:


<!--T:16-->
<!--T:16-->
The first thing you can do while starting your first content mod is to familiarize yourself with the '''[[Modding:The Asset System | Asset System]]'''. This is where most of the magic in Vintage Story is accomplished, and you'll be using these resources constantly while modding.  
The first thing to do while starting your first mod is to familiarize yourself with the '''[[Modding:Asset System |Asset System]]'''. This is where most of the magic in Vintage Story is accomplished, and you'll be using these resources constantly while modding.
 
<!--T:20-->
To move on with a content mod, head over to the [[Modding:Content Mods|Content Mods]] page.
To start with a theme pack, head over to the [[Modding:Theme_Pack|Theme Pack]] page.


<!--T:17-->
<!--T:17-->
Confirmedusers
637

edits