Modding:Mod Packaging: Difference between revisions

From Vintage Story Wiki
no edit summary
m (CreativeMD moved page Asset Mod to Game Content Mod)
No edit summary
Line 1: Line 1:
== Packing ==
== Info file ==


Every zip-file mod requires a <code>modinfo.json</code> inside the root directory of the archive. Otherwise the entire mod will be ignored. This info file specifies what kind of me it is, its name, author, etc.


== Info file ==
An example of a theme pack info file (<code>modinfo.json</code>):
<syntaxhighlight lang=json>
{
  "type": "content",
  "name": "My Example Content Mod",
  "description" : "This is an example mod, which does nothing",
  "author": "CreativeMD",
  "version": "1.0",
  "gameversions": [ "1.5.0.3+" ],
  "website": "http://example.com"
}
</syntaxhighlight>
 
----
 
<syntaxhighlight lang=json>
  "type": "theme",
</syntaxhighlight>
 
Defines this mod as being a '''ContentMod'''. Therefore it cannot any scripts or mod classes (it might contain some, but this will be ignored).
 
<syntaxhighlight lang=json>
  "gameversions": [ "1.5.0.3+" ],
</syntaxhighlight>
 
Means it requires at least VintageStory v1.5.0.3 or a newer version.
 
== Icon ==


The file <code>modicon.png</code> (if it exists) will be used and shown in the mod manager menu.


== Distribution ==
== Distribution ==
Feel free to share your creation in our [https://www.vintagestory.at/forums/forum/17-modifications/ forums]. We would love to see what you come up with.
Confirmedusers, editor, Administrators
886

edits