Modinfo: Difference between revisions

From Vintage Story Wiki
(add translate tag)
(Marked this version for translation)
Line 1: Line 1:
<languages/><translate>
<languages/><translate>
<!--T:1-->
{{GameVersion|1.15}}
{{GameVersion|1.15}}


== Overview ==
== Overview == <!--T:2-->
Every mod needs some basic information to be recognized as a mod. This can either happen by putting this info into the assembly (not recommended anymore) or by using the modinfo.json. The modinfo.json sits at the root of your mod directory and looks for example like this:
Every mod needs some basic information to be recognized as a mod. This can either happen by putting this info into the assembly (not recommended anymore) or by using the modinfo.json. The modinfo.json sits at the root of your mod directory and looks for example like this:
<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
Line 18: Line 19:
</syntaxhighlight>
</syntaxhighlight>


== Reference ==
== Reference == <!--T:3-->
The following properties and values are supported. '''Bold''' values are required. Properties are not case sensitive and may appear in any order.
The following properties and values are supported. '''Bold''' values are required. Properties are not case sensitive and may appear in any order.


<!--T:4-->
{| class="wikitable"
{| class="wikitable"
! Property !! Example !! Description
! Property !! Example !! Description
Line 53: Line 55:
|}
|}


=== Technical Note ===
=== Technical Note === <!--T:5-->
The <code>modinfo.json</code> properties correspond directly to the fields and properties on the [https://apidocs.vintagestory.at/api/Vintagestory.API.Common.ModInfo.html ModInfo] API class (and are loaded into that class internally using <code>JsonConvert.DeserializeObject</code>). Check the available fields in the api documentation to see a full up to date list of all possible properties.
The <code>modinfo.json</code> properties correspond directly to the fields and properties on the [https://apidocs.vintagestory.at/api/Vintagestory.API.Common.ModInfo.html ModInfo] API class (and are loaded into that class internally using <code>JsonConvert.DeserializeObject</code>). Check the available fields in the api documentation to see a full up to date list of all possible properties.


<!--T:6-->
{{Navbox/modding|Vintage Story}}
{{Navbox/modding|Vintage Story}}
</translate>
</translate>