Modding:Theme Pack: Difference between revisions

From Vintage Story Wiki
(Added some info about overriding game textures, and added an example mod.)
(Stripped all the info duplicated on the Mod Packaging page.)
Line 1: Line 1:
== Info file ==
'''Theme Packs''' are mods that do not change the game mechanics, only visuals, sounds, etc. They are [[Mod_Packaging|packed like any other mod]], using the type <code>"theme"</code>.


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.
Due to the way they work, theme packs never add new content, only replace existing content.
 
An example of a theme pack info file (<code>modinfo.json</code>):
<syntaxhighlight lang=json>
{
  "type": "theme",
  "name": "My Example Themepack",
  "description" : "This is a themepack and serves as an example.",
  "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 '''ThemePack'''. Therefore it cannot override gameplay affecting assets categories (such as blocktypes, itemtypes and so on) and no scripts or mod classes will be loaded.
 
<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.
 
[[File:ThemePack Icon.png]]


== Overriding Files ==
== Overriding Files ==
Line 41: Line 8:


Overriding assets from other mods is also possible, see [[The_Asset_System#Overwriting assets|the asset system]] page for more details. Check out [[Media:ExampleTexPack.zip|the example theme pack]] for a simple demo of overriding game assets.
Overriding assets from other mods is also possible, see [[The_Asset_System#Overwriting assets|the asset system]] page for more details. Check out [[Media:ExampleTexPack.zip|the example theme pack]] for a simple demo of overriding game assets.
== 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.

Revision as of 10:21, 4 March 2018

Theme Packs are mods that do not change the game mechanics, only visuals, sounds, etc. They are packed like any other mod, using the type "theme".

Due to the way they work, theme packs never add new content, only replace existing content.

Overriding Files

Replacing game files is fairly easy, just create a directory names "assets" with a directory named "game" inside it, then copy replacements for any asset in the game's "assets" directory here. For example, to overwrite the texture for low fertility soil blocks ("assets/textures/block/soil/fertlow.png") you would place your replacement at "assets/game/textures/block/soil/fertlow.png" inside your zip file.

Overriding assets from other mods is also possible, see the asset system page for more details. Check out the example theme pack for a simple demo of overriding game assets.

Retrieved from "https://wiki.vintagestory.at/index.php?title=Modding:Theme_Pack&oldid=2106"