How to make a recipe type of your own in a Minecraft mod
A recipe type of your own is a Recipe class, a RecipeType registered for it, and a RecipeSerializer that reads the JSON and sends the recipe to players (from 1.20.2 with a codec, and from 1.20.5 also a stream codec; before that by hand). Data packs then add recipes with “type”: “<mod>:<name>”, and your code finds one with the recipe manager’s getRecipeFor.
Works on Minecraft 1.20.1 to 26.3 on NeoForge; Minecraft 1.16.5 to 26.3 on Fabric; Minecraft 1.16.5 to 1.20.1 on Forge. Each example was compiled against its loader and version before it shipped in Linen.
- Write the Recipe with its matches, assemble and result.
- Write its RecipeSerializer (a codec and stream codec on 1.20.5 and newer).
- Register the RecipeType and the RecipeSerializer.
- Add recipes as JSON with your type; find them with getRecipeFor.
What you can change
Section titled “What you can change”The example uses these values. Change them in the code.
| Setting | In the example | What it does |
|---|---|---|
| ingredient | minecraft:cobblestone |
The example recipe’s ingredient. |
| result | minecraft:gravel |
The example recipe’s result. |
For each loader and version
Section titled “For each loader and version”The example mod is examplemod in the package com.example.examplemod. Use your own mod id and package.
Fabric 1.19.4 to 1.20.1
Section titled “Fabric 1.19.4 to 1.20.1”Uses:
RecipeRecipeSerializerRecipeTypeContainerBuiltInRegistries.RECIPE_TYPEBuiltInRegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
In 1.20.1 a recipe carries its own id (getId), a serializer reads the JSON by hand in fromJson (the result is {“item”: …, “count”: n}) and getRecipeFor returns the recipe itself, no RecipeHolder. Data packs read recipes from data/<namespace>/recipes/ (plural).
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.core.RegistryAccess;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.resources.ResourceLocation;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.ShapedRecipe;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public class GrindingRecipe implements Recipe<Container> { private final ResourceLocation id; private final Ingredient ingredient; private final ItemStack result;
public GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) { this.id = id; this.ingredient = ingredient; this.result = result; }
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input, RegistryAccess registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(RegistryAccess registries) { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON and sends it to players. public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { return new GrindingRecipe(id, Ingredient.fromJson(json.get("ingredient")), ShapedRecipe.itemStackFromJson(json.getAsJsonObject("result"))); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, FriendlyByteBuf buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();NeoForge 1.20.1, Forge 1.19.4 to 1.20.1
Section titled “NeoForge 1.20.1, Forge 1.19.4 to 1.20.1”Uses:
RecipeRecipeSerializer.fromJsonRecipeTypeForgeRegistries.RECIPE_SERIALIZERS
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.core.RegistryAccess;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.resources.ResourceLocation;import net.minecraft.util.GsonHelper;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.ShapedRecipe;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public record GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) implements Recipe<SimpleContainer> { // The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING.get(), new SimpleContainer(stack), level); }
@Override public boolean matches(SimpleContainer container, Level level) { return ingredient.test(container.getItem(0)); }
@Override public ItemStack assemble(SimpleContainer container, RegistryAccess registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(RegistryAccess registries) { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING.get(); }
// Reads the recipe from JSON (fromJson) and sends it to players (toNetwork, fromNetwork). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { Ingredient ingredient = Ingredient.fromJson(GsonHelper.getAsJsonObject(json, "ingredient")); ItemStack result = ShapedRecipe.itemStackFromJson(GsonHelper.getAsJsonObject(json, "result")); return new GrindingRecipe(id, ingredient, result); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, FriendlyByteBuf buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient().toNetwork(buf); buf.writeItem(recipe.result()); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.world.item.crafting.RecipeType;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.registries.RegistryObject;
public final class ModRecipeTypes { public static final DeferredRegister<RecipeType<?>> RECIPE_TYPES = DeferredRegister.create(ForgeRegistries.RECIPE_TYPES, ExampleMod.MOD_ID);
public static final RegistryObject<RecipeType<GrindingRecipe>> GRINDING = RECIPE_TYPES.register("grinding", () -> new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from the ExampleMod constructor: puts the recipe types on the mod event bus. public static void register() { RECIPE_TYPES.register(FMLJavaModLoadingContext.get().getModEventBus()); }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.registries.RegistryObject;
public final class ModRecipeSerializers { public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(ForgeRegistries.RECIPE_SERIALIZERS, ExampleMod.MOD_ID);
public static final RegistryObject<RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }
// Called from the ExampleMod constructor: puts the serializers on the mod event bus. public static void register() { RECIPE_SERIALIZERS.register(FMLJavaModLoadingContext.get().getModEventBus()); }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.register();In your main mod class, inside <init>:
ModRecipeSerializers.register();NeoForge 1.20.2
Section titled “NeoForge 1.20.2”Uses:
RecipeRecipeSerializerRecipeTypeContainerRegistries.RECIPE_TYPERegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
In 1.20.2 the result is read with CraftingRecipeCodecs.ITEMSTACK_OBJECT_CODEC, so the JSON names it with “item” and “count” (1.20.3 renamed that to “id”). Before 1.20.5 a serializer has a Codec for the JSON and fromNetwork and toNetwork for the packet, and data packs read recipes from data/<namespace>/recipes/ (plural).
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.Codec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.RegistryAccess;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.CraftingRecipeCodecs;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<Container> { public static final Codec<GrindingRecipe> CODEC = RecordCodecBuilder.create(instance -> instance.group( Ingredient.CODEC_NONEMPTY.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), CraftingRecipeCodecs.ITEMSTACK_OBJECT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new));
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING.get(), new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input, RegistryAccess registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(RegistryAccess registries) { return result; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING.get(); }
// Reads the recipe from JSON (codec) and sends it to players (fromNetwork and toNetwork). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public Codec<GrindingRecipe> codec() { return CODEC; }
@Override public GrindingRecipe fromNetwork(FriendlyByteBuf buf) { return new GrindingRecipe(Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeTypes { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeType<?>> RECIPE_TYPES = DeferredRegister.create(Registries.RECIPE_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeType<?>, RecipeType<GrindingRecipe>> GRINDING = RECIPE_TYPES.register("grinding", () -> new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeSerializer;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeSerializers { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(Registries.RECIPE_SERIALIZER, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeSerializer<?>, RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.RECIPE_TYPES.register(modEventBus);In your main mod class, inside <init>:
ModRecipeSerializers.RECIPE_SERIALIZERS.register(modEventBus);NeoForge 1.20.3 to 1.20.4
Section titled “NeoForge 1.20.3 to 1.20.4”Uses:
RecipeRecipeSerializerRecipeTypeContainerRegistries.RECIPE_TYPERegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
Before 1.20.5 a serializer has a Codec for the JSON and fromNetwork and toNetwork for the packet, and data packs read recipes from data/<namespace>/recipes/ (plural).
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.Codec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.RegistryAccess;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<Container> { public static final Codec<GrindingRecipe> CODEC = RecordCodecBuilder.create(instance -> instance.group( Ingredient.CODEC_NONEMPTY.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.ITEM_WITH_COUNT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new));
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING.get(), new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input, RegistryAccess registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(RegistryAccess registries) { return result; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING.get(); }
// Reads the recipe from JSON (codec) and sends it to players (fromNetwork and toNetwork). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public Codec<GrindingRecipe> codec() { return CODEC; }
@Override public GrindingRecipe fromNetwork(FriendlyByteBuf buf) { return new GrindingRecipe(Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeTypes { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeType<?>> RECIPE_TYPES = DeferredRegister.create(Registries.RECIPE_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeType<?>, RecipeType<GrindingRecipe>> GRINDING = RECIPE_TYPES.register("grinding", () -> new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeSerializer;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeSerializers { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(Registries.RECIPE_SERIALIZER, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeSerializer<?>, RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.RECIPE_TYPES.register(modEventBus);In your main mod class, inside <init>:
ModRecipeSerializers.RECIPE_SERIALIZERS.register(modEventBus);NeoForge 1.20.5 to 1.20.6
Section titled “NeoForge 1.20.5 to 1.20.6”Uses:
RecipeRecipeSerializerRecipeTypeContainerRegistries.RECIPE_TYPERegistries.RECIPE_SERIALIZERRecipeManager.getRecipeForStreamCodec
From 1.20.5 the serializer has a MapCodec for the JSON and a StreamCodec for the packet, the result is {“id”: …, “count”: n}, and data packs still read recipes from data/<namespace>/recipes/ (plural; it becomes recipe/ in 1.21).
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.MapCodec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.HolderLookup;import net.minecraft.network.RegistryFriendlyByteBuf;import net.minecraft.network.codec.StreamCodec;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<Container> { public static final MapCodec<GrindingRecipe> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group( Ingredient.CODEC_NONEMPTY.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.STRICT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new)); public static final StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> STREAM_CODEC = StreamCodec.composite( Ingredient.CONTENTS_STREAM_CODEC, GrindingRecipe::ingredient, ItemStack.STREAM_CODEC, GrindingRecipe::result, GrindingRecipe::new);
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING.get(), new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input, HolderLookup.Provider registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(HolderLookup.Provider registries) { return result; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING.get(); }
// Reads the recipe from JSON (codec) and sends it to players (streamCodec). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public MapCodec<GrindingRecipe> codec() { return CODEC; }
@Override public StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> streamCodec() { return STREAM_CODEC; } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeTypes { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeType<?>> RECIPE_TYPES = DeferredRegister.create(Registries.RECIPE_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeType<?>, RecipeType<GrindingRecipe>> GRINDING = RECIPE_TYPES.register("grinding", () -> new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeSerializer;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeSerializers { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(Registries.RECIPE_SERIALIZER, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeSerializer<?>, RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"id": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.RECIPE_TYPES.register(modEventBus);In your main mod class, inside <init>:
ModRecipeSerializers.RECIPE_SERIALIZERS.register(modEventBus);Fabric 1.20.2
Section titled “Fabric 1.20.2”Uses:
RecipeRecipeSerializerRecipeTypeContainerBuiltInRegistries.RECIPE_TYPEBuiltInRegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
In 1.20.2 the result is read with CraftingRecipeCodecs.ITEMSTACK_OBJECT_CODEC, so the JSON names it with “item” and “count” (1.20.3 renamed that to “id”). Before 1.20.5 a serializer has a Codec for the JSON and fromNetwork and toNetwork for the packet, and data packs read recipes from data/<namespace>/recipes/ (plural).
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.Codec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.RegistryAccess;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.CraftingRecipeCodecs;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<Container> { public static final Codec<GrindingRecipe> CODEC = RecordCodecBuilder.create(instance -> instance.group( Ingredient.CODEC_NONEMPTY.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), CraftingRecipeCodecs.ITEMSTACK_OBJECT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new));
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input, RegistryAccess registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(RegistryAccess registries) { return result; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON (codec) and sends it to players (fromNetwork and toNetwork). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public Codec<GrindingRecipe> codec() { return CODEC; }
@Override public GrindingRecipe fromNetwork(FriendlyByteBuf buf) { return new GrindingRecipe(Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();Fabric 1.20.3 to 1.20.4
Section titled “Fabric 1.20.3 to 1.20.4”Uses:
RecipeRecipeSerializerRecipeTypeContainerBuiltInRegistries.RECIPE_TYPEBuiltInRegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
Before 1.20.5 the result in the JSON is {“item”: …, “count”: n} (read here with ItemStack.ITEM_WITH_COUNT_CODEC), and a serializer has a Codec for the JSON and fromNetwork and toNetwork for the packet, no StreamCodec. Recipes take a Container as input and data packs read them from data/<namespace>/recipes/ (plural). Compile-tested against 1.20.3 and 1.20.4.
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.Codec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.RegistryAccess;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<Container> { public static final Codec<GrindingRecipe> CODEC = RecordCodecBuilder.create(instance -> instance.group( Ingredient.CODEC_NONEMPTY.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.ITEM_WITH_COUNT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new));
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input, RegistryAccess registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(RegistryAccess registries) { return result; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON (codec) and sends it to players (fromNetwork and toNetwork). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public Codec<GrindingRecipe> codec() { return CODEC; }
@Override public GrindingRecipe fromNetwork(FriendlyByteBuf buf) { return new GrindingRecipe(Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();Fabric 1.20.5 to 1.20.6
Section titled “Fabric 1.20.5 to 1.20.6”Uses:
RecipeRecipeSerializerRecipeTypeContainerBuiltInRegistries.RECIPE_TYPEBuiltInRegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
Before 1.21 recipes take a Container as input (here a SimpleContainer), and data packs read them from data/<namespace>/recipes/ (plural); this code is compile-tested against 1.20.6.
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.MapCodec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.HolderLookup;import net.minecraft.network.RegistryFriendlyByteBuf;import net.minecraft.network.codec.StreamCodec;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<Container> { public static final MapCodec<GrindingRecipe> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group( Ingredient.CODEC_NONEMPTY.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.STRICT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new)); public static final StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> STREAM_CODEC = StreamCodec.composite( Ingredient.CONTENTS_STREAM_CODEC, GrindingRecipe::ingredient, ItemStack.STREAM_CODEC, GrindingRecipe::result, GrindingRecipe::new);
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input, HolderLookup.Provider registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(HolderLookup.Provider registries) { return result; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON (codec) and sends it to players (streamCodec). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public MapCodec<GrindingRecipe> codec() { return CODEC; }
@Override public StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> streamCodec() { return STREAM_CODEC; } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"id": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();Fabric 1.21 to 1.21.1
Section titled “Fabric 1.21 to 1.21.1”Uses:
RecipeRecipeSerializerRecipeTypeSingleRecipeInputBuiltInRegistries.RECIPE_TYPEBuiltInRegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
Fabric’s page for recipe types is written for a later version; this code is compile-tested against 1.21.1.
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.MapCodec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.HolderLookup;import net.minecraft.network.RegistryFriendlyByteBuf;import net.minecraft.network.codec.StreamCodec;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.SingleRecipeInput;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipe/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<SingleRecipeInput> { public static final MapCodec<GrindingRecipe> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group( Ingredient.CODEC_NONEMPTY.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.STRICT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new)); public static final StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> STREAM_CODEC = StreamCodec.composite( Ingredient.CONTENTS_STREAM_CODEC, GrindingRecipe::ingredient, ItemStack.STREAM_CODEC, GrindingRecipe::result, GrindingRecipe::new);
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SingleRecipeInput(stack), level); }
@Override public boolean matches(SingleRecipeInput input, Level level) { return ingredient.test(input.item()); }
@Override public ItemStack assemble(SingleRecipeInput input, HolderLookup.Provider registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(HolderLookup.Provider registries) { return result; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON (codec) and sends it to players (streamCodec). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public MapCodec<GrindingRecipe> codec() { return CODEC; }
@Override public StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> streamCodec() { return STREAM_CODEC; } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipe/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"id": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();NeoForge 1.21 to 1.21.1
Section titled “NeoForge 1.21 to 1.21.1”Uses:
RecipeRecipeSerializerRecipeTypeSingleRecipeInputRegistries.RECIPE_TYPERegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.MapCodec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.HolderLookup;import net.minecraft.network.RegistryFriendlyByteBuf;import net.minecraft.network.codec.StreamCodec;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.SingleRecipeInput;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipe/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<SingleRecipeInput> { public static final MapCodec<GrindingRecipe> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group( Ingredient.CODEC_NONEMPTY.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.STRICT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new)); public static final StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> STREAM_CODEC = StreamCodec.composite( Ingredient.CONTENTS_STREAM_CODEC, GrindingRecipe::ingredient, ItemStack.STREAM_CODEC, GrindingRecipe::result, GrindingRecipe::new);
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING.get(), new SingleRecipeInput(stack), level); }
@Override public boolean matches(SingleRecipeInput input, Level level) { return ingredient.test(input.item()); }
@Override public ItemStack assemble(SingleRecipeInput input, HolderLookup.Provider registries) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem(HolderLookup.Provider registries) { return result; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING.get(); }
// Reads the recipe from JSON (codec) and sends it to players (streamCodec). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public MapCodec<GrindingRecipe> codec() { return CODEC; }
@Override public StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> streamCodec() { return STREAM_CODEC; } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeTypes { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeType<?>> RECIPE_TYPES = DeferredRegister.create(Registries.RECIPE_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeType<?>, RecipeType<GrindingRecipe>> GRINDING = RECIPE_TYPES.register("grinding", () -> new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeSerializer;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeSerializers { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(Registries.RECIPE_SERIALIZER, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeSerializer<?>, RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }}src/main/resources/data/examplemod/recipe/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"id": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.RECIPE_TYPES.register(modEventBus);In your main mod class, inside <init>:
ModRecipeSerializers.RECIPE_SERIALIZERS.register(modEventBus);Fabric 1.21.2 to 1.21.11
Section titled “Fabric 1.21.2 to 1.21.11”Uses:
RecipeRecipeSerializerRecipeTypeSingleRecipeInputBuiltInRegistries.RECIPE_TYPEBuiltInRegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
Recipes have a PlacementInfo and a recipe book category, and the recipe manager is reached through ServerLevel#recipeAccess; this code is compile-tested against 1.21.4.
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.MapCodec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.HolderLookup;import net.minecraft.network.RegistryFriendlyByteBuf;import net.minecraft.network.codec.StreamCodec;import net.minecraft.server.level.ServerLevel;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.PlacementInfo;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeBookCategories;import net.minecraft.world.item.crafting.RecipeBookCategory;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.SingleRecipeInput;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipe/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<SingleRecipeInput> { public static final MapCodec<GrindingRecipe> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group( Ingredient.CODEC.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.STRICT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new)); public static final StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> STREAM_CODEC = StreamCodec.composite( Ingredient.CONTENTS_STREAM_CODEC, GrindingRecipe::ingredient, ItemStack.STREAM_CODEC, GrindingRecipe::result, GrindingRecipe::new);
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(ServerLevel level, ItemStack stack) { return level.recipeAccess().getRecipeFor(ModRecipeTypes.GRINDING, new SingleRecipeInput(stack), level); }
@Override public boolean matches(SingleRecipeInput input, Level level) { return ingredient.test(input.item()); }
@Override public ItemStack assemble(SingleRecipeInput input, HolderLookup.Provider registries) { return result.copy(); }
// Nothing to show in the recipe book's grid: this recipe is not placed on a crafting grid. @Override public PlacementInfo placementInfo() { return PlacementInfo.NOT_PLACEABLE; }
@Override public RecipeBookCategory recipeBookCategory() { return RecipeBookCategories.CRAFTING_MISC; }
@Override public RecipeSerializer<GrindingRecipe> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<GrindingRecipe> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON (codec) and sends it to players (streamCodec). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public MapCodec<GrindingRecipe> codec() { return CODEC; }
@Override public StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> streamCodec() { return STREAM_CODEC; } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipe/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": "minecraft:cobblestone", "result": {"id": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();NeoForge 1.21.2 to 1.21.11
Section titled “NeoForge 1.21.2 to 1.21.11”Uses:
RecipeRecipeSerializerRecipeTypeSingleRecipeInputPlacementInfoRegistries.RECIPE_TYPERegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
Since 1.21.2 recipes are only on the server (ServerLevel#recipeAccess), an ingredient in JSON is a plain item id or #tag string, and a recipe names its recipe book category and placement info.
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.MapCodec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.core.HolderLookup;import net.minecraft.network.RegistryFriendlyByteBuf;import net.minecraft.network.codec.StreamCodec;import net.minecraft.server.level.ServerLevel;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.PlacementInfo;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeBookCategories;import net.minecraft.world.item.crafting.RecipeBookCategory;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.SingleRecipeInput;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipe/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<SingleRecipeInput> { public static final MapCodec<GrindingRecipe> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group( Ingredient.CODEC.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.STRICT_CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new)); public static final StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> STREAM_CODEC = StreamCodec.composite( Ingredient.CONTENTS_STREAM_CODEC, GrindingRecipe::ingredient, ItemStack.STREAM_CODEC, GrindingRecipe::result, GrindingRecipe::new);
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(ServerLevel level, ItemStack stack) { return level.recipeAccess().getRecipeFor(ModRecipeTypes.GRINDING.get(), new SingleRecipeInput(stack), level); }
@Override public boolean matches(SingleRecipeInput input, Level level) { return ingredient.test(input.item()); }
@Override public ItemStack assemble(SingleRecipeInput input, HolderLookup.Provider registries) { return result.copy(); }
@Override public RecipeSerializer<? extends Recipe<SingleRecipeInput>> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<? extends Recipe<SingleRecipeInput>> getType() { return ModRecipeTypes.GRINDING.get(); }
// Not shown in the recipe book's "place items" and not placeable by clicking. @Override public PlacementInfo placementInfo() { return PlacementInfo.NOT_PLACEABLE; }
@Override public RecipeBookCategory recipeBookCategory() { return RecipeBookCategories.CRAFTING_MISC; }
// Reads the recipe from JSON (codec) and sends it to players (streamCodec). public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public MapCodec<GrindingRecipe> codec() { return CODEC; }
@Override public StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> streamCodec() { return STREAM_CODEC; } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeTypes { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeType<?>> RECIPE_TYPES = DeferredRegister.create(Registries.RECIPE_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeType<?>, RecipeType<GrindingRecipe>> GRINDING = RECIPE_TYPES.register("grinding", () -> new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeSerializer;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeSerializers { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(Registries.RECIPE_SERIALIZER, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeSerializer<?>, RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }}src/main/resources/data/examplemod/recipe/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": "minecraft:cobblestone", "result": {"id": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.RECIPE_TYPES.register(modEventBus);In your main mod class, inside <init>:
ModRecipeSerializers.RECIPE_SERIALIZERS.register(modEventBus);NeoForge 26.1 to 26.3
Section titled “NeoForge 26.1 to 26.3”Uses:
RecipeRecipeSerializerRecipeTypeSingleRecipeInputPlacementInfoRegistries.RECIPE_TYPERegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
Since 1.21.2 recipes are only on the server (ServerLevel#recipeAccess), an ingredient in JSON is a plain item id or #tag string, and a recipe names its recipe book category and placement info.
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.MapCodec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.network.RegistryFriendlyByteBuf;import net.minecraft.network.codec.StreamCodec;import net.minecraft.server.level.ServerLevel;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.ItemStackTemplate;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.PlacementInfo;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeBookCategories;import net.minecraft.world.item.crafting.RecipeBookCategory;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.SingleRecipeInput;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipe/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStackTemplate result) implements Recipe<SingleRecipeInput> { public static final MapCodec<GrindingRecipe> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group( Ingredient.CODEC.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStackTemplate.CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new)); public static final StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> STREAM_CODEC = StreamCodec.composite( Ingredient.CONTENTS_STREAM_CODEC, GrindingRecipe::ingredient, ItemStackTemplate.STREAM_CODEC, GrindingRecipe::result, GrindingRecipe::new);
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(ServerLevel level, ItemStack stack) { return level.recipeAccess().getRecipeFor(ModRecipeTypes.GRINDING.get(), new SingleRecipeInput(stack), level); }
@Override public boolean matches(SingleRecipeInput input, Level level) { return ingredient.test(input.item()); }
@Override public ItemStack assemble(SingleRecipeInput input) { return result.create(); }
@Override public RecipeSerializer<? extends Recipe<SingleRecipeInput>> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<? extends Recipe<SingleRecipeInput>> getType() { return ModRecipeTypes.GRINDING.get(); }
@Override public String group() { return ""; }
@Override public boolean showNotification() { return false; }
// Not shown in the recipe book's "place items" and not placeable by clicking. @Override public PlacementInfo placementInfo() { return PlacementInfo.NOT_PLACEABLE; }
@Override public RecipeBookCategory recipeBookCategory() { return RecipeBookCategories.CRAFTING_MISC; }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeType;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeTypes { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeType<?>> RECIPE_TYPES = DeferredRegister.create(Registries.RECIPE_TYPE, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeType<?>, RecipeType<GrindingRecipe>> GRINDING = RECIPE_TYPES.register("grinding", () -> new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.registries.Registries;import net.minecraft.world.item.crafting.RecipeSerializer;import net.neoforged.neoforge.registries.DeferredHolder;import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeSerializers { // Registered on the mod event bus in ExampleMod's constructor. public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(Registries.RECIPE_SERIALIZER, ExampleMod.MOD_ID);
public static final DeferredHolder<RecipeSerializer<?>, RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", () -> new RecipeSerializer<>(GrindingRecipe.CODEC, GrindingRecipe.STREAM_CODEC));
private ModRecipeSerializers() { }}src/main/resources/data/examplemod/recipe/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": "minecraft:cobblestone", "result": {"id": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.RECIPE_TYPES.register(modEventBus);In your main mod class, inside <init>:
ModRecipeSerializers.RECIPE_SERIALIZERS.register(modEventBus);Fabric 26.1 to 26.3
Section titled “Fabric 26.1 to 26.3”Uses:
RecipeRecipeSerializerRecipeTypeSingleRecipeInputBuiltInRegistries.RECIPE_TYPEBuiltInRegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
Recipes have a PlacementInfo and a recipe book category, and the recipe manager is reached through ServerLevel#recipeAccess; this code is compile-tested against 1.21.4.
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.mojang.serialization.MapCodec;import com.mojang.serialization.codecs.RecordCodecBuilder;import java.util.Optional;import net.minecraft.network.RegistryFriendlyByteBuf;import net.minecraft.network.codec.StreamCodec;import net.minecraft.server.level.ServerLevel;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.PlacementInfo;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeBookCategories;import net.minecraft.world.item.crafting.RecipeBookCategory;import net.minecraft.world.item.crafting.RecipeHolder;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.SingleRecipeInput;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipe/*.json with "type": "examplemod:grinding".public record GrindingRecipe(Ingredient ingredient, ItemStack result) implements Recipe<SingleRecipeInput> { public static final MapCodec<GrindingRecipe> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group( Ingredient.CODEC.fieldOf("ingredient").forGetter(GrindingRecipe::ingredient), ItemStack.CODEC.fieldOf("result").forGetter(GrindingRecipe::result)).apply(instance, GrindingRecipe::new)); public static final StreamCodec<RegistryFriendlyByteBuf, GrindingRecipe> STREAM_CODEC = StreamCodec.composite( Ingredient.CONTENTS_STREAM_CODEC, GrindingRecipe::ingredient, ItemStack.STREAM_CODEC, GrindingRecipe::result, GrindingRecipe::new);
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<RecipeHolder<GrindingRecipe>> find(ServerLevel level, ItemStack stack) { return level.recipeAccess().getRecipeFor(ModRecipeTypes.GRINDING, new SingleRecipeInput(stack), level); }
@Override public boolean matches(SingleRecipeInput input, Level level) { return ingredient.test(input.item()); }
@Override public ItemStack assemble(SingleRecipeInput input) { return result.copy(); }
// Nothing to show in the recipe book's grid: this recipe is not placed on a crafting grid. @Override public PlacementInfo placementInfo() { return PlacementInfo.NOT_PLACEABLE; }
@Override public RecipeBookCategory recipeBookCategory() { return RecipeBookCategories.CRAFTING_MISC; }
@Override public boolean showNotification() { return true; }
@Override public String group() { return ""; }
@Override public RecipeSerializer<GrindingRecipe> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<GrindingRecipe> getType() { return ModRecipeTypes.GRINDING; }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new RecipeSerializer<>(GrindingRecipe.CODEC, GrindingRecipe.STREAM_CODEC));
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipe/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": "minecraft:cobblestone", "result": {"id": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();Forge 1.17.1
Section titled “Forge 1.17.1”Uses:
RecipeRecipeSerializer.fromJsonRecipeTypeForgeRegistries.RECIPE_SERIALIZERS
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import net.minecraftforge.registries.ForgeRegistryEntry;import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.resources.ResourceLocation;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.ShapedRecipe;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public class GrindingRecipe implements Recipe<Container> { private final ResourceLocation id; private final Ingredient ingredient; private final ItemStack result;
public GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) { this.id = id; this.ingredient = ingredient; this.result = result; }
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem() { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON and sends it to players. public static final class Serializer extends ForgeRegistryEntry<RecipeSerializer<?>> implements RecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { return new GrindingRecipe(id, Ingredient.fromJson(json.get("ingredient")), ShapedRecipe.itemStackFromJson(json.getAsJsonObject("result"))); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, FriendlyByteBuf buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { // RecipeType.register adds the type to the vanilla recipe type registry (1.18.2 has no Forge registry for it). public static final RecipeType<GrindingRecipe> GRINDING = RecipeType.register("examplemod:grinding");
private ModRecipeTypes() { }
// Called from the mod's constructor; loading this class registers the type above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.fmllegacy.RegistryObject;
public final class ModRecipeSerializers { public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(ForgeRegistries.RECIPE_SERIALIZERS, ExampleMod.MOD_ID);
public static final RegistryObject<RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }
// Called from the ExampleMod constructor: puts the serializers on the mod event bus. public static void register() { RECIPE_SERIALIZERS.register(FMLJavaModLoadingContext.get().getModEventBus()); }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.register();In your main mod class, inside <init>:
ModRecipeSerializers.register();Forge 1.18.2
Section titled “Forge 1.18.2”Uses:
RecipeRecipeSerializer.fromJsonRecipeTypeForgeRegistries.RECIPE_SERIALIZERS
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import net.minecraftforge.registries.ForgeRegistryEntry;import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.resources.ResourceLocation;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.ShapedRecipe;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public class GrindingRecipe implements Recipe<Container> { private final ResourceLocation id; private final Ingredient ingredient; private final ItemStack result;
public GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) { this.id = id; this.ingredient = ingredient; this.result = result; }
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem() { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON and sends it to players. public static final class Serializer extends ForgeRegistryEntry<RecipeSerializer<?>> implements RecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { return new GrindingRecipe(id, Ingredient.fromJson(json.get("ingredient")), ShapedRecipe.itemStackFromJson(json.getAsJsonObject("result"))); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, FriendlyByteBuf buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { // RecipeType.register adds the type to the vanilla recipe type registry (1.18.2 has no Forge registry for it). public static final RecipeType<GrindingRecipe> GRINDING = RecipeType.register("examplemod:grinding");
private ModRecipeTypes() { }
// Called from the mod's constructor; loading this class registers the type above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.registries.RegistryObject;
public final class ModRecipeSerializers { public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(ForgeRegistries.RECIPE_SERIALIZERS, ExampleMod.MOD_ID);
public static final RegistryObject<RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }
// Called from the ExampleMod constructor: puts the serializers on the mod event bus. public static void register() { RECIPE_SERIALIZERS.register(FMLJavaModLoadingContext.get().getModEventBus()); }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.register();In your main mod class, inside <init>:
ModRecipeSerializers.register();Forge 1.19 to 1.19.3
Section titled “Forge 1.19 to 1.19.3”Uses:
RecipeRecipeSerializer.fromJsonRecipeTypeForgeRegistries.RECIPE_SERIALIZERS
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.resources.ResourceLocation;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.ShapedRecipe;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public class GrindingRecipe implements Recipe<Container> { private final ResourceLocation id; private final Ingredient ingredient; private final ItemStack result;
public GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) { this.id = id; this.ingredient = ingredient; this.result = result; }
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING.get(), new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem() { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING.get(); }
// Reads the recipe from JSON and sends it to players. public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { return new GrindingRecipe(id, Ingredient.fromJson(json.get("ingredient")), ShapedRecipe.itemStackFromJson(json.getAsJsonObject("result"))); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, FriendlyByteBuf buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.world.item.crafting.RecipeType;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.registries.RegistryObject;
public final class ModRecipeTypes { public static final DeferredRegister<RecipeType<?>> RECIPE_TYPES = DeferredRegister.create(ForgeRegistries.RECIPE_TYPES, ExampleMod.MOD_ID);
public static final RegistryObject<RecipeType<GrindingRecipe>> GRINDING = RECIPE_TYPES.register("grinding", () -> new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from the ExampleMod constructor: puts the recipe types on the mod event bus. public static void register() { RECIPE_TYPES.register(FMLJavaModLoadingContext.get().getModEventBus()); }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;import net.minecraftforge.registries.RegistryObject;
public final class ModRecipeSerializers { public static final DeferredRegister<RecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(ForgeRegistries.RECIPE_SERIALIZERS, ExampleMod.MOD_ID);
public static final RegistryObject<RecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }
// Called from the ExampleMod constructor: puts the serializers on the mod event bus. public static void register() { RECIPE_SERIALIZERS.register(FMLJavaModLoadingContext.get().getModEventBus()); }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.register();In your main mod class, inside <init>:
ModRecipeSerializers.register();Fabric 1.19.3
Section titled “Fabric 1.19.3”Uses:
RecipeRecipeSerializerRecipeTypeContainerBuiltInRegistries.RECIPE_TYPEBuiltInRegistries.RECIPE_SERIALIZERRecipeManager.getRecipeFor
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.resources.ResourceLocation;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.ShapedRecipe;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public class GrindingRecipe implements Recipe<Container> { private final ResourceLocation id; private final Ingredient ingredient; private final ItemStack result;
public GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) { this.id = id; this.ingredient = ingredient; this.result = result; }
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem() { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON and sends it to players. public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { return new GrindingRecipe(id, Ingredient.fromJson(json.get("ingredient")), ShapedRecipe.itemStackFromJson(json.getAsJsonObject("result"))); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, FriendlyByteBuf buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.core.registries.BuiltInRegistries;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(BuiltInRegistries.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();Fabric 1.17 to 1.19.2
Section titled “Fabric 1.17 to 1.19.2”Uses:
RecipeRecipeSerializerRecipeTypeContainerRegistry.RECIPE_TYPERegistry.RECIPE_SERIALIZERRecipeManager.getRecipeFor
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.resources.ResourceLocation;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.ShapedRecipe;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public class GrindingRecipe implements Recipe<Container> { private final ResourceLocation id; private final Ingredient ingredient; private final ItemStack result;
public GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) { this.id = id; this.ingredient = ingredient; this.result = result; }
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem() { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON and sends it to players. public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { return new GrindingRecipe(id, Ingredient.fromJson(json.get("ingredient")), ShapedRecipe.itemStackFromJson(json.getAsJsonObject("result"))); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, FriendlyByteBuf buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(Registry.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(Registry.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();Fabric 1.16.5
Section titled “Fabric 1.16.5”Uses:
RecipeRecipeSerializerRecipeTypeContainerRegistry.RECIPE_TYPERegistry.RECIPE_SERIALIZERRecipeManager.getRecipeFor
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.network.FriendlyByteBuf;import net.minecraft.resources.ResourceLocation;import net.minecraft.world.Container;import net.minecraft.world.SimpleContainer;import net.minecraft.world.item.ItemStack;import net.minecraft.world.item.crafting.Ingredient;import net.minecraft.world.item.crafting.Recipe;import net.minecraft.world.item.crafting.RecipeSerializer;import net.minecraft.world.item.crafting.RecipeType;import net.minecraft.world.item.crafting.ShapedRecipe;import net.minecraft.world.level.Level;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public class GrindingRecipe implements Recipe<Container> { private final ResourceLocation id; private final Ingredient ingredient; private final ItemStack result;
public GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) { this.id = id; this.ingredient = ingredient; this.result = result; }
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(Level level, ItemStack stack) { return level.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new SimpleContainer(stack), level); }
@Override public boolean matches(Container input, Level level) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(Container input) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem() { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public RecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING; }
@Override public RecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON and sends it to players. public static final class Serializer implements RecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { return new GrindingRecipe(id, Ingredient.fromJson(json.get("ingredient")), ShapedRecipe.itemFromJson(json.getAsJsonObject("result"))); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, FriendlyByteBuf buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(FriendlyByteBuf buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.world.item.crafting.RecipeType;
public final class ModRecipeTypes { public static final RecipeType<GrindingRecipe> GRINDING = Registry.register(Registry.RECIPE_TYPE, ExampleMod.id("grinding"), new RecipeType<GrindingRecipe>() { @Override public String toString() { return "examplemod:grinding"; } });
private ModRecipeTypes() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe types above. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.core.Registry;import net.minecraft.world.item.crafting.RecipeSerializer;
public final class ModRecipeSerializers { public static final RecipeSerializer<GrindingRecipe> GRINDING = Registry.register(Registry.RECIPE_SERIALIZER, ExampleMod.id("grinding"), new GrindingRecipe.Serializer());
private ModRecipeSerializers() { }
// Called from ExampleMod#onInitialize; loading this class registers the recipe serializers above. public static void register() { }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside onInitialize:
ModRecipeTypes.register();In your main mod class, inside onInitialize:
ModRecipeSerializers.register();Forge 1.16.5
Section titled “Forge 1.16.5”Uses:
IRecipeIRecipeSerializerIRecipeType.registerRecipeManager.getRecipeFor
In 1.16.5 a recipe type is registered with IRecipeType.register, when the class loads; only the serializer goes through a DeferredRegister.
src/main/java/com/example/examplemod/recipe/GrindingRecipe.java
package com.example.examplemod.recipe;
import com.example.examplemod.registry.ModRecipeSerializers;import com.example.examplemod.registry.ModRecipeTypes;import com.google.gson.JsonObject;import java.util.Optional;import net.minecraft.inventory.Inventory;import net.minecraft.inventory.IInventory;import net.minecraft.item.ItemStack;import net.minecraft.item.crafting.IRecipe;import net.minecraft.item.crafting.IRecipeSerializer;import net.minecraft.item.crafting.IRecipeType;import net.minecraft.item.crafting.Ingredient;import net.minecraft.item.crafting.ShapedRecipe;import net.minecraft.network.PacketBuffer;import net.minecraft.util.ResourceLocation;import net.minecraft.world.World;import net.minecraftforge.registries.ForgeRegistryEntry;
// A Grinding recipe: one ingredient gives one result. Data packs add them as data/<namespace>/recipes/*.json with "type": "examplemod:grinding".public class GrindingRecipe implements IRecipe<IInventory> { private final ResourceLocation id; private final Ingredient ingredient; private final ItemStack result;
public GrindingRecipe(ResourceLocation id, Ingredient ingredient, ItemStack result) { this.id = id; this.ingredient = ingredient; this.result = result; }
// The recipe for an item, if a loaded data pack has one: what a machine or block of yours would ask. public static Optional<GrindingRecipe> find(World world, ItemStack stack) { return world.getRecipeManager().getRecipeFor(ModRecipeTypes.GRINDING, new Inventory(stack), world); }
@Override public boolean matches(IInventory input, World world) { return ingredient.test(input.getItem(0)); }
@Override public ItemStack assemble(IInventory input) { return result.copy(); }
@Override public boolean canCraftInDimensions(int width, int height) { return true; }
@Override public ItemStack getResultItem() { return result; }
@Override public ResourceLocation getId() { return id; }
@Override public IRecipeSerializer<?> getSerializer() { return ModRecipeSerializers.GRINDING.get(); }
@Override public IRecipeType<?> getType() { return ModRecipeTypes.GRINDING; }
// Reads the recipe from JSON and sends it to players. public static final class Serializer extends ForgeRegistryEntry<IRecipeSerializer<?>> implements IRecipeSerializer<GrindingRecipe> { @Override public GrindingRecipe fromJson(ResourceLocation id, JsonObject json) { return new GrindingRecipe(id, Ingredient.fromJson(json.get("ingredient")), ShapedRecipe.itemFromJson(json.getAsJsonObject("result"))); }
@Override public GrindingRecipe fromNetwork(ResourceLocation id, PacketBuffer buf) { return new GrindingRecipe(id, Ingredient.fromNetwork(buf), buf.readItem()); }
@Override public void toNetwork(PacketBuffer buf, GrindingRecipe recipe) { recipe.ingredient.toNetwork(buf); buf.writeItem(recipe.result); } }}src/main/java/com/example/examplemod/registry/ModRecipeTypes.java
package com.example.examplemod.registry;
import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.item.crafting.IRecipeType;
public final class ModRecipeTypes { // 1.16.5: a recipe type is registered when this class loads, with its full name. public static final IRecipeType<GrindingRecipe> GRINDING = IRecipeType.register("examplemod:grinding");
private ModRecipeTypes() { }
// Called from the ExampleMod constructor: loading this class registers the recipe type. public static void register() { }}src/main/java/com/example/examplemod/registry/ModRecipeSerializers.java
package com.example.examplemod.registry;
import com.example.examplemod.ExampleMod;import com.example.examplemod.recipe.GrindingRecipe;import net.minecraft.item.crafting.IRecipeSerializer;import net.minecraftforge.fml.RegistryObject;import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;import net.minecraftforge.registries.DeferredRegister;import net.minecraftforge.registries.ForgeRegistries;
public final class ModRecipeSerializers { public static final DeferredRegister<IRecipeSerializer<?>> RECIPE_SERIALIZERS = DeferredRegister.create(ForgeRegistries.RECIPE_SERIALIZERS, ExampleMod.MOD_ID);
public static final RegistryObject<IRecipeSerializer<GrindingRecipe>> GRINDING = RECIPE_SERIALIZERS.register("grinding", GrindingRecipe.Serializer::new);
private ModRecipeSerializers() { }
// Called from the ExampleMod constructor: puts the serializers on the mod event bus. public static void register() { RECIPE_SERIALIZERS.register(FMLJavaModLoadingContext.get().getModEventBus()); }}src/main/resources/data/examplemod/recipes/grinding_example.json
{ "type": "examplemod:grinding", "ingredient": {"item": "minecraft:cobblestone"}, "result": {"item": "minecraft:gravel", "count": 1}}In your main mod class, inside <init>:
ModRecipeTypes.register();In your main mod class, inside <init>:
ModRecipeSerializers.register();Sources
Section titled “Sources”- https://docs.neoforged.net/docs/1.21.1/resources/server/recipes/
- https://docs.fabricmc.net/1.21.11/develop/custom-recipe-types
Related how-tos
Section titled “Related how-tos”- A block entity that ticks
- Add drops to Minecraft’s loot
- A block that does something when clicked
- A block that gives off particles
- A mob with attributes and a spawn egg
In Linen
Section titled “In Linen”Linen’s How-tos library has this page too, with the example for your own mod’s loader and Minecraft version. Hover a name in your code and Linen points to the how-tos that explain it. Both are free. Download Linen.