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-08-27 19:16:32 -07:00
parent 761cb75d86
commit 20adfcbe77
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Mod-Data-Format.md
+5 -6
View File
@@ -1,13 +1,12 @@
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 data file is stored in 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 format described later on this page.
Each mod should also have its own directory under `/static/browse`. This directory should contain:
Each mod data file is stored in its own directory under `/data`. The directory should be named using the Mod's slug name (see: [[About Slugs]]). This directory should contain:
* a file named `mod.cg` using the format described on this page
* a 160x160 `icon.png` file used to represent the mod in various places on the site
* (optional) a `tutorials` directory. See [[Tutorial Data Format]] for details.
* a directory for each item (named using the item's slug). Each directory should have a 48x48
`icon.png` file for that item. See [[Mod Version Data Format]] for details.
* an `items` directory containing a directory for each item (named using the item's slug). Each directory should
have a 48x48 `icon.png` file for that item. See [[Mod Version Data Format]] for details.
## Example
@@ -77,4 +76,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.
For each version listed, a subdirectory should exist under `/static/data/<mod_slug>/<version>` containing a `mod-version.cg` file. See [[Mod Version Data Format]] for details on this file's format.
For each version listed, a subdirectory should exist under `/data/<mod_slug>/versions/<version>` containing a `mod-version.cg` file. See [[Mod Version Data Format]] for details on this file's format.