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

Updated Mod Version Data Format (markdown)

Browse Source
This commit is contained in:
Andrew Miner
2016-03-14 21:49:27 -07:00
parent 05abbe5610
commit 798cd3b6a9
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Mod-Version-Data-Format.md
+5 -6
View File
@@ -51,7 +51,7 @@ You can check your file for errors by running the `grunt test` command from the
You can pretty-print a data file using the `./scripts/reformat <file> (<output>|-)?` command. This will You can pretty-print a data file using the `./scripts/reformat <file> (<output>|-)?` 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. 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.
Please be sure to use these two commands prior to submitting a pull request for a new data file! Please be sure to use these commands prior to submitting a pull request for a new data file!
## Command Reference ## Command Reference
@@ -61,21 +61,20 @@ Please be sure to use these two commands prior to submitting a pull request for
* `group: <group>` * `group: <group>`
Starts an item group. Groups are used simply to organize items on the mod detail page, and don't need Starts an item group. Groups are simply used to organize items on the mod detail page, and don't need
to correspond to anything in-game. Any items declared before the first group declaration are not part to correspond to anything in-game. Any items declared before the first group declaration are not part
of any group. of any group.
* `item: <item name>` * `item: <item name>`
Starts and item declaration. The item name should be the item's actual in-game name. Spelling, Starts an item declaration. The item name should exactly match the item's actual in-game name. Spelling,
punctuation (if any), and spaces are relevant. Extended UTF-8 characters are permitted. punctuation (if any), and spaces are relevant. Extended UTF-8 characters are permitted.
This command should be used once for each item in the mod. You should avoid using it to declare any 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. items from vanilla Minecraft, or from other mods as these will already be added by other files.
Each item should have a related icon file at `/data/<mod-slug>/items/<item-slug>/icon.png`. The image should be Each item should have a related icon file at `/data/<mod-slug>/items/<item-slug>/icon.png`. The image should
48x48px and be exported from NEI as described in [Adding Support for a New Mod 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).
(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`. After an item declaration, the following commands may be used to describe it: `gatherable`, `recipe`.