craftingguide/wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Mod Data Format (markdown)

Browse Source
This commit is contained in:
Andrew Miner
2015-03-22 10:23:09 -07:00
parent e8189162c2
commit f30c7bbca3
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Mod-Data-Format.md
+2 -2
View File
@@ -1,6 +1,6 @@
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 slug name (see: [About Slugs](https://github.com/andrewminer/crafting-guide/wiki/About-Slugs)), and contain a file named `mod.cg` using the following format. Each mod is described with its own directory under `/static/data`. The directory should be named using the Mod's slug name (see: [[About Slugs]]), and contain a file named `mod.cg` using the following format.
## Example ## Example
@@ -70,4 +70,4 @@ Each line of the file should usually contain a single command. Each command has
Multiple versions may be specified, and if so, they should be listed with the most recent first. Multiple versions may be specified, and if so, they should be listed with the most recent first.
For each version listed, a subdirectory should exist with exactly the same name containing a [ModVersion data file](https://github.com/andrewminer/crafting-guide/wiki/Mod-Version-Data-Format) and an images subdirectory. For each version listed, a subdirectory should exist with exactly the same name containing a [[Mod Version Data Format]]).