Custom Recipes - Revision history

ChampionAsh5357: Update to 1.19

2022-06-13T20:07:08Z

Update to 1.19

ChampionAsh5357: Improve overall documentation for custom recipes

2021-09-25T21:26:18Z

Improve overall documentation for custom recipes

Show changes

ChampionAsh5357: Update to 1.17 and fix all the wrong information, probably should come back later to finish at some point

2021-08-02T22:41:38Z

Update to 1.17 and fix all the wrong information, probably should come back later to finish at some point

RobotGryphon: /* Setup */

2021-06-05T17:45:19Z

Setup

RobotGryphon: Created page with "= Custom Recipe Serializers = Want to make a custom recipe type for a machine, or some mechanic your mod has? Great! It means users can participate in the datapack system for..."

2021-06-05T17:32:00Z

Created page with "= Custom Recipe Serializers = Want to make a custom recipe type for a machine, or some mechanic your mod has? Great! It means users can participate in the datapack system for..."

New page

= Custom Recipe Serializers =

Want to make a custom recipe type for a machine, or some mechanic your mod has? Great! It means users can participate in the datapack system for recipes, so you get automatic syncing, updating, and ease of maintenance on servers. Here's what you need to get started:

== Classes/Interfaces for the inventories and serialization ==

==== IRecipeSerializer ====
The thing that actually serializes recipe files. It implements the vanilla recipe serializer interface and provides means of reading from JSON and performing read/write operations on network buffer objects. One should look into using [[Codecs]] for this class, as using them simplifies the logic significantly.

<syntaxhighlight lang="java">
public class MyRecipeSerializer
extends ForgeRegistryEntry<IRecipeSerializer<?>>
implements IRecipeSerializer<MyRecipeType> {

// your serializer code here

}
</syntaxhighlight>

==== IRecipeType ====
Links the recipe type to its implementation class. This is a very lightweight class that vanilla uses to make a recipe file's <code>type</code> line to which serializer should be used to deserialize a recipe into an instance.

==== IInventory ====
Wraps vanilla's <code>IInventory</code> system. [https://gist.github.com/robotgryphon/344e5815e27f28fef7a837c4f98ade40 Here's a reference.] '''''Note this should not be used directly; you should make a fake inventory class and handle the actual match implementation with your own methods and logic.'''''

==== IRecipe ====
Your actual recipe class or an abstraction to cheat vanilla's system and use your own recipe matching system. Takes the <code>IInventory</code> from above and matches it. Your recipe class should return the <code>IRecipeType</code> from registration in the getType override.

== Setup ==
Once you have the above implementations, here's how to wire everything up:

# Register your recipe serializer to the <code>RECIPE_SERIALIZERS</code> Forge registry.
# Register the recipe type during the registration (constructor) phase. See below.
# Place a JSON file in <code>data/recipes/my_recipe.json</code> and ensure it has <code>"type": "mymod:my_recipe_type"</code> in the JSON structure.

<syntaxhighlight lang="java">
Registry.register(Registry.RECIPE_TYPE, new ResLoc('mymod:my_recipe_type'), MyRecipeType.class);
</syntaxhighlight>

This will load the recipe using the recipe serialization system, and wire it back to the serializer via type matching the value you specified during the <code>RECIPE_TYPE</code> registration above, in step 2.

@@ Line 67: / Line 67: @@
 === RecipeType ===
-<code>RecipeType</code> is another interface; however, it does not store any data itself. It is simply a non-forge wrapped registry object which represents the category the <code>Recipe</code> implementation belongs to. As such, it only needs to be supplied its registry name. This can be registered via <code>RecipeType#register</code> by either static initialization or deferring the registration until <code>FMLCommonSetupEvent</code>.
+<code>RecipeType</code> is another interface; however, it does not store any data itself. It is simply a forge-wrapped registry object which represents the category the <code>Recipe</code> implementation belongs to.
 === RecipeSerializer ===
-<code>RecipeSerializer</code> is an interface which takes some JSON and transforms it into a <code>Recipe</code>. It is also responsible for syncing the recipe data to the client. This is a forge wrapped registry object; however, since it is an interface, there is a bit more work needed for ease of implementation. This is because <code>RecipeSerializer</code> extends <code>IForgeRegistryEntry</code> which has three abstract methods. For ease of use, the implementation should extends <code>ForgeRegistryEntry<RecipeSerializer<?>></code> such that you do not need to implement these methods yourself.
+<code>RecipeSerializer</code> is an interface which takes some JSON and transforms it into a <code>Recipe</code>. It is also responsible for syncing the recipe data to the client.
 There are only three methods within <code>RecipeSerializer</code>, but they all must be implemented:

← Older revision		Revision as of 17:45, 5 June 2021
Line 38:		Line 38:
	</syntaxhighlight>		</syntaxhighlight>

−	This will load the recipe using the recipe serialization system, and wire it back to the serializer via ~~type~~ matching the ~~value you specified during the~~ <code>~~RECIPE_TYPE~~</code> ~~registration above,~~ in step 2.	+	This will load the recipe using the recipe serialization system, and wire it back to the serializer via matching the registry name in <code>type</code> to the value you specified while registering the serializer in step 1.

@@ Line 5: / Line 5: @@
 == Classes/Interfaces for the inventories and serialization ==
-==== IRecipeSerializer ====
+==== RecipeSerializer ====
 The thing that actually serializes recipe files. It implements the vanilla recipe serializer interface and provides means of reading from JSON and performing read/write operations on network buffer objects. One should look into using [[Codecs]] for this class, as using them simplifies the logic significantly.
 <syntaxhighlight lang="java">
 public class MyRecipeSerializer
-   extends ForgeRegistryEntry<IRecipeSerializer<?>>
+   extends ForgeRegistryEntry<RecipeSerializer<?>>
-   implements IRecipeSerializer<MyRecipeType> {
+   implements RecipeSerializer<MyRecipe> {
    // your serializer code here
@@ Line 18: / Line 18: @@
 </syntaxhighlight>
-==== IRecipeType ====
+==== RecipeType ====
-Links the recipe type to its implementation class. This is a very lightweight class that vanilla uses to make a recipe file's <code>type</code> line to which serializer should be used to deserialize a recipe into an instance.
+Links the recipe type to its implementation class(es). This is a very lightweight class that vanilla uses to determine what recipes are associated with what implementors (e.g. <code>CRAFTING</code> is for <code>SHAPED_RECIPE</code>, <code>SHAPELESS_RECIPE</code>, etc.).
-==== IInventory ====
+==== Container ====
-Wraps vanilla's <code>IInventory</code> system. [https://gist.github.com/robotgryphon/344e5815e27f28fef7a837c4f98ade40 Here's a reference.] '''''Note this should not be used directly; you should make a fake inventory class and handle the actual match implementation with your own methods and logic.'''''
+Vanilla's inventory system used in recipes to grab references to implementors to see if the associated recipe matches the current container data.
-==== IRecipe ====
+==== Recipe ====
-Your actual recipe class or an abstraction to cheat vanilla's system and use your own recipe matching system. Takes the <code>IInventory</code> from above and matches it. Your recipe class should return the <code>IRecipeType</code> from registration in the getType override.
+Your actual recipe class or an abstraction to use your own recipe matching system. Takes the <code>Container</code> from above and matches it. Your recipe class should return the <code>RecipeType</code> from registration in <code>#getType</code> and the serializer in <code>#getSerializer</code>.
 == Setup ==
@@ Line 31: / Line 31: @@
 # Register your recipe serializer to the <code>RECIPE_SERIALIZERS</code> Forge registry.
-# Register the recipe type during the registration (constructor) phase. See below.
+# Register the recipe type during the common setup event or statically. See below.
-# Place a JSON file in <code>data/recipes/my_recipe.json</code> and ensure it has <code>"type": "mymod:my_recipe_type"</code> in the JSON structure.
+# Place a JSON file in <code>data/recipes/my_recipe.json</code> and ensure it has <code>"type": "mymod:my_recipe_serializer_registry_name"</code> in the JSON structure.
 <syntaxhighlight lang="java">
-Registry.register(Registry.RECIPE_TYPE, new ResLoc('mymod:my_recipe_type'), MyRecipeType.class);
+RecipeType.register("mymod:my_recipe_type");
 </syntaxhighlight>
-This will load the recipe using the recipe serialization system, and wire it back to the serializer via matching the registry name in <code>type</code> to the value you specified while registering the serializer in step 1.
+This will load the recipe using the recipe serialization system, and wire it back to the serializer via matching the registry name of the serializer to the value you specified while registering the serializer in step 1.