Updated Mod Data Format (markdown)

This commit is contained in:
Andrew Miner
2015-02-03 10:06:40 -08:00
parent bfa1a46f4b
commit 895233ea51
+2
View File
@@ -1,5 +1,7 @@
The Mod 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 and what versions are supported. Most commands are optional, and can be entered in any order. Anywhere this isn't true will be called out below. The Mod 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 and what versions are supported. Most commands are optional, and can be entered in any order. Anywhere this isn't true will be called out below.
Each mod is described with its own directory under `/src/data`. The directory should be named using the Mod's stub name (see: [Adding Support for a new Mod](https://github.com/andrewminer/crafting-guide/wiki/Adding-support-for-a-new-Mod)), and contain a file named `mod.cg` using the following format.
## Example ## Example
```yaml ```yaml