diff --git a/Crafting-Guide-Data-Format-V2.md b/Crafting-Guide-Data-Format-V2.md index 857f83c..145df14 100644 --- a/Crafting-Guide-Data-Format-V2.md +++ b/Crafting-Guide-Data-Format-V2.md @@ -82,4 +82,43 @@ item: Certus Quartz Crystal different ways, each yielding more and more iron. Recipes should be listed in order from least to most complex. 4. Put the highest yielding recipe first. Where all recipes are of equivalent complexity (e.g., - producing Rose Red from Poppies or Rose Bushes), place the recipe which produces the most first. \ No newline at end of file + producing Rose Red from Poppies or Rose Bushes), place the recipe which produces the most first. + +* `input: , , ...` _(required)_ + + Lists the items needed for the current recipe. The names here must match *exactly* with the name of + the item listed else where in this (or another) file. Failure to do so will cause it to show up in + the "Items You'll Need" section with a question mark icon. + + For recipes where an item is being smelted, the convention is to require a single "furnace fuel" item + to represent the fuel used in the furnace for that single item. + + This command is required after each `recipe` command. + +* `pattern: ` + + Describes the placement of each input item in the 3×3 crafting grid. A pattern is an 11 character + string composed of numbers or periods composed into 3 groups of 3 by spaces. Each number refers to an + item in the `input` list (starting from 0). A period refers to a spot on the grid which is left + blank. + + Each item in the `input` list must appear in the pattern, and each number in the pattern must + correspond to an item in the `input` list. + + For shapeless recipes, you place the items wherever you like, but be sure to include the correct + number of each (e.g., you'll need to show 4 Snowballs in the pattern for a Snow block). + + For recipes which use tools other than a crafting table, try to create a pattern which most closely + matches the in-game UI for that tool. For example, for a furnace, place the item to smelt in the top- + center position, and the fuel in the bottom-center position. + + Here are a few examples: + + Item | Commands + -------------------|--------- + Iron Pickaxe | `input: Iron Ingot, Stick; pattern: 000 .1. .1.` + Stone Slab | `input: Stone; pattern: ... 000 ...` + Oak Wood Planks | `input: Oak Wood; pattern: ... .0. ...` + Cobblestone Stairs | `input: Cobblestone; pattern: 0.. 00. 000` + Piston | `input: Oak Wood Planks, Cobblestone, Iron Ingot, Redstone; pattern: 000 121 131` + Iron Ingot | `input: Iron Ore, furnace fuel; pattern: .0. ... .1.`