Recipes

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 will be expanded in Minecraft 1.13 into datapacks.

Loading Recipes

Forge will load all recipes which can be found within the ./assets/<modid>/recipes/ folder. You can call these files whatever you want, thought the vanilla convention is to name them after the output item. This name is also used as the registration key, but does not affect the operation of the recipe.

Note

Recipe files cannot begin with an underscore as this is reserved for constants files. The JSON file extension is required.

The Recipe file

A basic recipe file might look like the following example:

{
    "type": "minecraft:crafting_shaped",
    "pattern":
    [
        "xxa",
        "x x",
        "xxx"
    ],
    "key":
    {
        "x":
        {
            "type": "forge:ore_dict",
            "ore": "gemDiamond"
        },
        "a":
        {
            "item": "mymod:myfirstitem",
            "data": 1
        }
    },
    "result":
    {
        "item": "mymod:myitem",
        "count": 9,
        "data": 2
    }
}

Note

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 Advancement system and create a new Advancement for each of your ingredients.

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 minecraft:crafting_shaped or minecraft:crafting_shapeless.

If you want, you can define your own types as well which requires the use of a _factories.json file.

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 pattern and key 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. Additional the type forge:ore_dict may be added. This defines the item beeing part of the OreDictionary and can for example be used when it doesn’t matter which copper ore is used to produce a copper ingot. In this case the ore tag has to be used instead of the item tag to define the item. There are many more of these types which can be used here and you can even register your own. The data tag is a optional and used to define the metadata of a block or item.

Important

Any item which uses setHasSubtypes(true) requires the use of the data field. When it is not used within the ingredients or keys, it will mean any metadata of this item will be accepted, for example: Not defining the data of a sword means even a half broken sword will be accepted for the crafting recipe!

Shapeless crafting

A shapeless recipe doesn’t make use of the pattern and key keywords.

To define a shapeless recipe, you have to use the ingredients list. It defines which items have to be used for the crafting process and can also make use of the additional type forge:ore_dict and it’s functionality as described above. 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.

Note

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.

    "ingredients": [
        {
            "type": "forge:ore_dict",
            "ore": "gemDiamond"
        },
        {
            "item": "minecraft:nether_star"
        }
    ],

Smelting

To define a recipe for the furnace, you have to use GameRegistry.addSmelting(input, output, exp); as the smelting recipes are currently not JSON based.

Recipe Elements

Patterns

A pattern will be defined with the pattern 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.

  "key": {
     "#": [
      {
        "item": "minecraft:planks",
         "data": 0
      },
      {
        "item": "minecraft:planks",
        "data": 1
      }
    ]
  }

Results

Every recipe 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 count 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 count number anywhere else than for the result. The data field is a optional and used to define the metadata of a block or item. It defaults to 0 when it doesn’t exist.

Note

Any item which uses setHasSubtypes(true) requires the data field. In this case, it is not optional!

Factories

Factories can be used to allow defining recipes and ingredients of a custom type (class). To create your own factory, create a _factories.json. Within this file a type has to be defined, for example: recipes, ingredients or conditions. These types represent IRecipeFactory, IIngredientFactory, and IConditionFactory, respectively. The entry “key” must be a name which can be later used in your recipes, and the “value” is the fully qualified class name is a class you have to create which implements one of the above recipes. The class must have an empty constructor. For example:

{
    "<type>": {
        "<name>": "<fully qualified classname for the specified type>"
    }
}

Note

There is no need to create a new _factories.json for each type you want to specify, they can all be defined in a single file.

Conditional Recipes

Conditional recipes can be created by making use of the factory system described above. For this you use the conditions type with the IConditionFactory from above and can later add the conditions type to your recipes:

Note

Conditions will only be checked once at startup!

Constants

It is possible to define constant values for your recipes. These values have to be defined within a _constants.json and can be used within any recipe of your mod by just writing #<name>. For filled buckets, you should use fluid instead of data. For example, this constant defines #SADDLE which represents the vanilla saddle item.

[
    {
        "name": "SADDLE",
        "ingredient": {
            "item": "minecraft:saddle",
            "data": 0
        }
    }
]