Updated Mod Data Format (markdown)

This commit is contained in:
Andrew Miner
2015-03-22 12:49:48 -07:00
parent 94e7408cf7
commit 4eac47715b
+8 -1
View File
@@ -2,6 +2,13 @@ The Mod file format is a very simple command-based language which is very simila
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 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:
* 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.
## Example ## Example
```yaml ```yaml
@@ -70,4 +77,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 [[Mod Version Data Format]]. 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.