77
edits
Changes
Inital Import doku wiki
With the update to Minecraft 1.12, Mojang introduced a new data-driven recipe system based on JSON files. Since then it has been adopted by Forge as well and was expanded in Minecraft 1.13 into [https://mcforge.readthedocs.io/en/latest/utilities/recipes/datapacks.md datapacks]. <!-- needs wiki page -->
== Loading Recipes ==
Forge will load all recipes which can be found within the <code><nowiki>./data/<modid>/recipes/</nowiki></code> folder. You can call these files whatever you want, thought the vanilla convention is to name them after the output item. For multiple recipes from different sources (Smelting, Crafting, etc) one vanilla convention is to use <code><nowiki>item_name_from_smelting.json</nowiki></code>. This name is also used as the registration key, but does not affect the operation of the recipe.
== The Recipe file ==
A basic recipe file might look like the following example:
<syntaxhighlight lang="json">
{
"type": "minecraft:crafting_shaped",
"pattern":
[
"xxa",
"x x",
"xxx"
],
"key":
{
"x":
{
"tag": "forge:gems/diamond"
},
"a":
{
"item": "mymod:myfirstitem",
}
},
"result":
{
"item": "mymod:myitem",
"count": 9,
}
}
</syntaxhighlight>
{{Colored box|title=Tip|content=When you first obtain an ingredient to a vanilla recipe it will automatically unlock the recipe in the recipe book. To achieve the same effect, you have to use the <code><nowiki>Advancement</nowiki></code> system and create a new <code><nowiki>Advancement</nowiki></code> for each of your ingredients.
<br><br>
The advancement has to exist. This doesn’t mean it has to be visible in the advancement tree.}}
=== Type ===
The type of a recipe with the type field. You can think of this as the definition of which crafting layout is to be used, for example <code><nowiki>minecraft:crafting_shaped</nowiki></code> or <code><nowiki>minecraft:crafting_shapeless</nowiki></code>.
=== Groups ===
Optionally you can add a group to your recipes to be displayed within the recipe helper interface. All recipes with the same group String will be shown in the same group. For example, this can be used to have all door recipes shown in the recipe helper interface as a single entry, even though there are different types of doors.
== Types of crafting recipes ==
Within this section we will take a closer look on the differences between defining a shaped and a shapeless crafting recipe.
=== Shaped crafting ===
Shaped recipes require the <code><nowiki>pattern</nowiki></code> and <code><nowiki>key</nowiki></code> keywords. A pattern defines the slot an item must appear in using placeholder characters. You can choose whatever character you want to be a placeholder for an item. Keys on the other hand define what items are to be used instead of the placeholders. A key is defined by a placeholder character and the item.
=== Shapeless crafting ===
A shapeless recipe doesn’t make use of the <code><nowiki>pattern</nowiki></code> and <code><nowiki>key</nowiki></code> keywords.
To define a shapeless recipe, you have to use the <code><nowiki>ingredients</nowiki></code> list. It defines which items have to be used for the crafting process. There are many more of these types which can be used here and you can even register your own. It is even possible to define multiple instances of the same item which means multiple of these items have to be in place for the crafting recipe to take place.
<block tip>While there is no limit on how many ingredients your recipe requires the vanilla crafting table does only allow 9 items to be placed for each crafting recipe.</block>
{{Colored box|title=Tip|content=While there is no limit on how many ingredients your recipe requires the vanilla crafting table does only allow 9 items to be placed for each crafting recipe.}}
The following example shows how an ingredient list looks like within JSON.
<syntaxhighlight lang="json">
"ingredients": [
{
"tag": "forge:gems/diamond"
},
{
"item": "minecraft:nether_star"
}
],
</syntaxhighlight>
== Recipe Elements ==
=== Patterns ===
A pattern will be defined with the <code><nowiki>pattern</nowiki></code> list. Each string represents one row in the crafting grid and each placeholder character within the String represents a column. As seen in the example above a space means that no item needs to be inserted at that position.
=== Keys ===
A key set is used in combination with patterns and contains keys whose name is the same as the placeholder character in the pattern list which it represents. One key may be defined to represent multiply items as it is the case for the wooden button. This means that the player can use one of the defined items for the crafting recipe, for example different types of wood.
<syntaxhighlight lang="json">
"key": {
"#": [
{
"item": "minecraft:oak_planks"
},
{
"item": "minecraft:spruce_planks"
}
]
}
</syntaxhighlight>
=== Results ===
Every <code><nowiki>recipe</nowiki></code> has to have a result tag to define the output item.
When crafting something, you can get out more than one item. This is achieved by defining the <code><nowiki>count</nowiki></code> number. If this is left out, meaning it doesn’t exist within the result block, it defaults to 1. Negative values are not allowed here as an Itemstack cannot be smaller than 0. There is no option to use the <code><nowiki>count</nowiki></code> number anywhere else than for the result.
== Loading Recipes ==
Forge will load all recipes which can be found within the <code><nowiki>./data/<modid>/recipes/</nowiki></code> folder. You can call these files whatever you want, thought the vanilla convention is to name them after the output item. For multiple recipes from different sources (Smelting, Crafting, etc) one vanilla convention is to use <code><nowiki>item_name_from_smelting.json</nowiki></code>. This name is also used as the registration key, but does not affect the operation of the recipe.
== The Recipe file ==
A basic recipe file might look like the following example:
<syntaxhighlight lang="json">
{
"type": "minecraft:crafting_shaped",
"pattern":
[
"xxa",
"x x",
"xxx"
],
"key":
{
"x":
{
"tag": "forge:gems/diamond"
},
"a":
{
"item": "mymod:myfirstitem",
}
},
"result":
{
"item": "mymod:myitem",
"count": 9,
}
}
</syntaxhighlight>
{{Colored box|title=Tip|content=When you first obtain an ingredient to a vanilla recipe it will automatically unlock the recipe in the recipe book. To achieve the same effect, you have to use the <code><nowiki>Advancement</nowiki></code> system and create a new <code><nowiki>Advancement</nowiki></code> for each of your ingredients.
<br><br>
The advancement has to exist. This doesn’t mean it has to be visible in the advancement tree.}}
=== Type ===
The type of a recipe with the type field. You can think of this as the definition of which crafting layout is to be used, for example <code><nowiki>minecraft:crafting_shaped</nowiki></code> or <code><nowiki>minecraft:crafting_shapeless</nowiki></code>.
=== Groups ===
Optionally you can add a group to your recipes to be displayed within the recipe helper interface. All recipes with the same group String will be shown in the same group. For example, this can be used to have all door recipes shown in the recipe helper interface as a single entry, even though there are different types of doors.
== Types of crafting recipes ==
Within this section we will take a closer look on the differences between defining a shaped and a shapeless crafting recipe.
=== Shaped crafting ===
Shaped recipes require the <code><nowiki>pattern</nowiki></code> and <code><nowiki>key</nowiki></code> keywords. A pattern defines the slot an item must appear in using placeholder characters. You can choose whatever character you want to be a placeholder for an item. Keys on the other hand define what items are to be used instead of the placeholders. A key is defined by a placeholder character and the item.
=== Shapeless crafting ===
A shapeless recipe doesn’t make use of the <code><nowiki>pattern</nowiki></code> and <code><nowiki>key</nowiki></code> keywords.
To define a shapeless recipe, you have to use the <code><nowiki>ingredients</nowiki></code> list. It defines which items have to be used for the crafting process. There are many more of these types which can be used here and you can even register your own. It is even possible to define multiple instances of the same item which means multiple of these items have to be in place for the crafting recipe to take place.
<block tip>While there is no limit on how many ingredients your recipe requires the vanilla crafting table does only allow 9 items to be placed for each crafting recipe.</block>
{{Colored box|title=Tip|content=While there is no limit on how many ingredients your recipe requires the vanilla crafting table does only allow 9 items to be placed for each crafting recipe.}}
The following example shows how an ingredient list looks like within JSON.
<syntaxhighlight lang="json">
"ingredients": [
{
"tag": "forge:gems/diamond"
},
{
"item": "minecraft:nether_star"
}
],
</syntaxhighlight>
== Recipe Elements ==
=== Patterns ===
A pattern will be defined with the <code><nowiki>pattern</nowiki></code> list. Each string represents one row in the crafting grid and each placeholder character within the String represents a column. As seen in the example above a space means that no item needs to be inserted at that position.
=== Keys ===
A key set is used in combination with patterns and contains keys whose name is the same as the placeholder character in the pattern list which it represents. One key may be defined to represent multiply items as it is the case for the wooden button. This means that the player can use one of the defined items for the crafting recipe, for example different types of wood.
<syntaxhighlight lang="json">
"key": {
"#": [
{
"item": "minecraft:oak_planks"
},
{
"item": "minecraft:spruce_planks"
}
]
}
</syntaxhighlight>
=== Results ===
Every <code><nowiki>recipe</nowiki></code> has to have a result tag to define the output item.
When crafting something, you can get out more than one item. This is achieved by defining the <code><nowiki>count</nowiki></code> number. If this is left out, meaning it doesn’t exist within the result block, it defaults to 1. Negative values are not allowed here as an Itemstack cannot be smaller than 0. There is no option to use the <code><nowiki>count</nowiki></code> number anywhere else than for the result.