Changes between Version 18 and Version 19 of Modding_Guide

Timestamp:

Dec 12, 2015, 12:46:14 AM (8 years ago)

Author:

leper

Comment:

Add information about mod.json files.

Modding_Guide

@@ -63 +63 @@
 Additionally, if you want to mod the latest greatest version of the game, you might consider getting the latest data from SVN. For Windows users we provide a precompiled version of the game in SVN, so programming/compiling knowledge is not required. Still you will be expected to have a working knowledge of Windows, file management, and basic troubleshooting. See the [wiki:BuildInstructions build instructions] for details on acquiring the latest version of the game for your OS.
 
+== How to make your mod show up in the mod selection screen ==
+
+You need to add a `mod.json` file to your mod folder. See the public (0 A.D.) mod's [source:ps/trunk/binaries/data/mods/public/mod.json mod.json] file for a real world example of an standalone mod.
+
+The following is a (nearly minimal) sample:
+{{{
+{
+    name: "samplemod",
+    version: "1.2.34",
+    label: "Sample Mod",
+    description: "This is an example discription",
+    dependencies: ["0ad=0.0.19"]
+}
+}}}
+
+There are also the `url` and `type` properties which are optional. `name` must be unique and must not contain whitespace. `dependencies` is an array that contains the `name` of mods it depends on, optionally with version constraints (<,<=,==,>=,>) and the versions of the dependency.
+
+For details of how the dependency checking is done please read the function comments in [source:ps/trunk/binaries/data/mods/mod/gui/modmod/modmod.js modmod.js].
+
 == Distributing your mods ==