diff --git a/Mod-Version-Data-Format.md b/Mod-Version-Data-Format.md index a92728b..2d20e86 100644 --- a/Mod-Version-Data-Format.md +++ b/Mod-Version-Data-Format.md @@ -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