diff --git a/Mod-Version-Data-Format.md b/Mod-Version-Data-Format.md index 1869947..e803922 100644 --- a/Mod-Version-Data-Format.md +++ b/Mod-Version-Data-Format.md @@ -2,8 +2,6 @@ The ModVersion file format is a very simple command-based language which is very 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 ```yaml @@ -48,7 +46,7 @@ group: Circuits Each line of the file should usually contain a single command. Each command has the format: `: , , ...`. All of the available commands are described below. Multiple commands may be listed on the same line by separating them with `;` characters. Comments are entered using the `#` character, which can itself be escaped if you need to use it in an item name. Blank lines are ignored. Whitespace is generally irrelevant outside item names, but following the conventions described above makes things easier. -You can check your file for errors by running the `./scripts/verify ` command on your file. This examine the file and print out any errors. If no errors are found, there is no output. While working on a data file, it is often handy to use the UNIX `watch` command to provide continuous feedback: `watch ./script/verify `. +You can check your file for errors by running the `grunt test` command from the root of the `crafting-guide-data` directory. This examine all the various files and print out any errors. While working on a data file, it is often handy to use the `grunt watch` command to continuously run the tests after any changes. You can pretty-print a data file using the `./scripts/reformat (|-)?` command. This will correct indentation, alphabetize items, and generally clean things up. Omitting the second argument will reformat the given file in place. Providing a `-` as the second argument will print the reformatted file to `stdout` without actually modifying the original. @@ -75,9 +73,9 @@ Please be sure to use these two commands prior to submitting a pull request for This command should be used once for each item in the mod. You should avoid using it to declare any items from vanilla Minecraft, or from other mods as these will already be added by other files. - Each item should an image file named using the item's slug in the `/src/data///images` - directory. The image should be 48x48px and be exported from NEI as described in [Adding Support for a - New Mod](https://github.com/andrewminer/crafting-guide/wiki/Adding-support-for-a-new-Mod). + Each item should have a related icon file at `/data//items//icon.png`. The image should be + 48x48px and be exported from NEI as described in [Adding Support for a New Mod + (https://github.com/andrewminer/crafting-guide/wiki/Adding-support-for-a-new-Mod). After an item declaration, the following commands may be used to describe it: `gatherable`, `recipe`.