Updated Mod Version Data Format (markdown)

This commit is contained in:
Andrew Miner
2015-02-03 10:18:05 -08:00
parent 23d833d182
commit 01afdba5fc
+5 -1
View File
@@ -1,4 +1,8 @@
The ModVersion file format is a very simple command-based language which is very similar to [YAML](http://www.yaml.org). There are commands for entering all various kinds of data needed to describe a mod's items and the recipes for those items. Most commands are optional, and can be entered in any order. Anywhere this isn't true will be called out below.
The ModVersion file format is a very simple command-based language which is very similar to [YAML](http://www.yaml.org). There are commands for entering all various kinds of data needed to describe the items and recipes for those items which belong to a specific version of a mod. Most commands are optional, and can be entered in any order. Anywhere this isn't true will be called out below.
ModVersion files are expected to be named `mod-version.cg` and appear within a directory named according to the specific version it represents (e.g., "6.2.6") which itself appears within a directory for the mod itself. See [Mod Data Format](https://github.com/andrewminer/crafting-guide/wiki/Mod-Data-Format) for further details.
Each mod version directory should also contain an `images` subdirectory which contains an image file for each item described by the mod version. These images may be obtained as described in [Adding Support for a New Mod](https://github.com/andrewminer/crafting-guide/wiki/Adding-support-for-a-new-Mod).
## Example