# Recipes Custom machine recipes can be made with Crafttweaker. Create a .zs file in the `scripts` folder (ex: `custom_machine_recipes.zs`). Then inside the .zs file you can use `mods.custommachinery.CMRecipeBuilder.create(machine, time)` to create the custom machine recipe builder, pass it the id of the machine you want to make the recipe for and the duration of the recipe (in ticks). Add some requirements to the builder then call `.build();` to register the recipe. You can also use `.build(recipe_name);` to register the recipe with a custom name.\ The recipe name can be any string in lowercase and without whitespace or special characters. Also two recipes can't have the same name. ```java mods.custommachinery.CMRecipeBuilder.create("namespace:machine_id", duration) //Create the builder // Add requirements here .build(); //Build and register the recipe .build(recipe_name); //Same as above but you can set a custom recipe name. ``` 🔴**DON'T FORGET THE SEMICOLON ";" AFTER THE BUILD METHOD**🔴 ### Requirements You can add various requirements by calling the methods below directly on the custom machine recipe builder.
Items **Use one of these methods to add an** [**Item Requirement**](/custom-machinery-1.16/recipes/requirements/item.md) **to the recipe.** ```java .requireItem(IItemStack item) .requireItem(IItemStack item, String slot) .requireItemTag(Tag tag, int amount) .requireItemTag(Tag tag, int amount, IData nbt) .requireItemTag(Tag tag, int amount, IData nbt, String slot) .produceItem(IItemStack item) .produceItem(IItemStack item, String slot) ``` * The `item` param must be an [IItemStack](https://docs.blamejared.com/1.16/en/vanilla/api/items/IItemStack/). \ Example : ` * 5` * The `slot` param must be a string corresponding to a slot id defined in a custom machine json [Item Component](/custom-machinery-1.16/creating-custom-machines/machine-components/item-component.md) `slot` property.\ It is optional and the default value is `""` (no specific slot required). * The `tag` param must be a [CT item tag brackets](https://docs.blamejared.com/1.16/en/tutorial/IntroductionToScripting/WhatAreBracketHandlers/#tag-format). Example : `` * The `amount` param must be a positive integer. * The `nbt` param must be a [IData](https://docs.blamejared.com/1.16/en/vanilla/api/data/IData/). Example : `{tag1: 1}`.\ It is optional and the default value is no tag required.\ This param **MUST** be specified if you want to use the `slot` param after.
Durability **Use one of these methods to add a** [**Durability Requirement**](/custom-machinery-1.16/recipes/requirements/durability.md) **to the recipe.** ```java .damageItem(IItemStack item, int amount) .damageItem(IItemStack item, int amount, String slot) .damageItemTag(Tag tag, int amount) .damageItemTag(Tag tag, int amount, IData nbt) .damageItemTag(Tag tag, int amount, IData nbt, String slot) .repairItem(IItemStack item, int amount) .repairItem(IItemStack item, int amount, String slot) .repairItemTag(Tag tag, int amount) .repairItemTag(Tag tag, int amount, IData nbt) .repairItemTag(Tag tag, int amount, IData nbt, String slot) ``` * The `item` param must be an [IItemStack](https://docs.blamejared.com/1.16/en/vanilla/api/items/IItemStack/). \ Example : ` * 5` * The `slot` param must be a string corresponding to a slot id defined in a custom machine json [Item Component](/custom-machinery-1.16/creating-custom-machines/machine-components/item-component.md) `slot` property.\ It is optional and the default value is `""` (no specific slot required). * The `tag` param must be a [CT item tag brackets](https://docs.blamejared.com/1.16/en/tutorial/IntroductionToScripting/WhatAreBracketHandlers/#tag-format). Example : `` * The `amount` param must be a positive integer. * The `nbt` param must be a [IData](https://docs.blamejared.com/1.16/en/vanilla/api/data/IData/). Example : `{tag1: 1}`.\ It is optional and the default value is no tag required.\ This param **MUST** be specified if you want to use the `slot` param after.
Fluid **Use one of these methods to add a** [**Fluid Requirement**](/custom-machinery-1.16/recipes/requirements/fluid.md) **to the recipe.** ```java .requireFluid(IFluidStack fluid) .requireFluid(IFluidStack fluid, String tank) .requireFluidTag(Tag tag, int amount) .requireFluidTag(Tag tag, int amount, IData nbt) .requireFluidTag(Tag tag, int amount, IData nbt, String tank) .produceFluid(IFluidStack fluid) .produceFluid(IFluidStack fluid, String tank) .requireFluidPerTick(IFluidStack fluid) .requireFluidPerTick(IFluidStack fluid, String tank) .requireFluidTagPerTick(Tag tag, int amount) .requireFluidTagPerTick(Tag tag, int amount, IData nbt) .requireFluidTagPerTick(Tag tag, int amount, IData nbt, String tank) .produceFluidPerTick(IFluidStack fluid) .produceFluidPerTick(IFluidStack fluid, String tank) ``` * The `fluid` param must be an [IFluidStack](https://docs.blamejared.com/1.16/en/vanilla/api/fluid/IFluidStack/). \ Example : ` * 1000` * The `nbt` param must be a [IData](https://docs.blamejared.com/1.16/en/vanilla/api/data/IData/). Example : `{tag1: 1}`.\ If you don't want the item to have a nbt you can pass `null`. * The `tank` param must be a string corresponding to a tank id defined in a custom machine json [Fluid Component](/custom-machinery-1.16/creating-custom-machines/machine-components/fluid-component.md) `tank` property.\ It is optional and the default value is no specific slot. * The `tag` param must be a [CT fluid tag brackets](https://docs.blamejared.com/1.16/en/tutorial/IntroductionToScripting/WhatAreBracketHandlers/#tag-format). Example : `` * The `amount` param must be a positive integer.
Energy **Use one of these methods to add an** [**Energy Requirement**](/custom-machinery-1.16/recipes/requirements/energy.md) **to the recipe.** ```java .requireEnergy(int amount) .requireEnergyPerTick(int amount) .produceEnergy(int amount) .produceEnergyPerTick(int amount) ``` * The `amount` param must be a positive integer.
Time **Use one of these methods to add a** [**Time Requirement**](/custom-machinery-1.16/recipes/requirements/time.md) **to the recipe.** ```java .requireTime(String time) .requireTime(String[] times) ``` * The `time` param must be a string or an array of strings. \ Look at the [Time Requirement](/custom-machinery-1.16/recipes/requirements/time.md) wiki page to know what to put here.
Position **Use one of these methods to add a** [**Position Requirement**](/custom-machinery-1.16/recipes/requirements/position.md) **to the recipe.** ```java .requirePosition(String position) .requirePosition(String[] positions) ``` * The `position` param must be a string or an array of strings. \ Look at the [Position Requirement](/custom-machinery-1.16/recipes/requirements/position.md) wiki page to know what to put here.
Biome **Use one of these methods to add a** [**Biome Requirement**](/custom-machinery-1.16/recipes/requirements/biome.md) **to the recipe.** ```java .biomeWhitelist(Biome biome) .biomeWhitelist(Biome[] biomes) .biomeBlacklist(Biome biome) .biomeBlacklist(Biomes[] biomes) ``` * The `biome` param must be a [biome brackets](https://docs.blamejared.com/1.16/en/vanilla/api/BracketHandlers/#g-getbiome). \ Example : ``
Dimension #### **Use one of these methods to add a** [Dimension **Requirement**](/custom-machinery-1.16/recipes/requirements/dimension.md) **to the recipe.** ```java .dimensionWhitelist(String dimension) .dimensionWhitelist(String[] dimensions) .dimensionBlacklist(String dimension) .dimensionBlacklist(String[] dimensions) ``` * The `dimension` param must be a string defining a valid dimension id. \ Example : `minecraft:overworld`
Fuel **Use this method to add a** [**Fuel Requirement**](/custom-machinery-1.16/recipes/requirements/fuel.md) **to the recipe.** ```java .requireFuel() .requireFuel(int amount) ``` * The `amount` param must be a positive integer that define the amount of fuel burned each tick of the recipe processing.\ Default to 1 when not specified.
Command **Use one of these methods to add a** [**Command Requirement**](/custom-machinery-1.16/recipes/requirements/command.md) **to the recipe.** ```java .runCommandOnStart(String command) .runCommandOnStart(String command, int permissionLevel) .runCommandOnStart(String command, int permissionLevel, boolean log) .runCommandEachTick(String command) .runCommandEachTick(String command, int permissionLevel) .runCommandEachTick(String command, int permissionLevel, boolean log) .runCommandOnEnd(String command) .runCommandOnEnd(String command, int permissionLevel) .runCommandOnEnd(String command, int permissionLevel, boolean log) ``` * The `command` param must be a string starting by `/` which will be run as a command. * The `permissionLevel` param must be a positive integer. \ Default : `2` * The `log` param must be a boolean, if true the command will be logged in admin chat as a system command. \ Default : `false`
Effect **Use one of these methods to add an** [**Effect Requirement**](/custom-machinery-1.16/recipes/requirements/effect.md) **to the recipe.** ```java .giveEffectOnEnd(Effect effect, int time, int radius) .giveEffectOnEnd(Effect effect, int time, int radius, int level) .giveEffectOnEnd(Effect effect, int time, int radius, int level, Entity[] filter) .giveEffectEachTick(Effect effect, int time, int radius) .giveEffectEachTick(Effect effect, int time, int radius, int level) .giveEffectEachTick(Effect effect, int time, int radius, int level, Entity[] filter) ``` * The `effect` param must be a [Effect brackets](https://docs.blamejared.com/1.16/en/vanilla/api/BracketHandlers/#g-geteffect). \ Example : `` * The `time` and `radius` params must be a positive integer. * The `level` param must be a positive integer. Default : `1` * The `filter` param must be an array of [entity types](https://docs.blamejared.com/1.16/en/vanilla/api/BracketHandlers/#g-getentitytype). \ Example : `[, "]` Default : `[]`
Weather **Use one of these methods to add a** [**Weather Requirement**](/custom-machinery-1.16/recipes/requirements/weather.md) **to the recipe.** ```java .requireWeather(String weather) .requireWeatherOnMachine(String weather) ``` * The `weather` param must be a string defining the required weather. \ Valid values : `clear`, `rain`, `snow`, `thunder`
Redstone **Use one of these methods to add a** [**Redstone Requirement**](/custom-machinery-1.16/recipes/requirements/redstone.md) **to the recipe.** ```java .requireRedstone(int power) .requireRedstone(int power, String comparator) ``` * The `power` param must be a positive integer between 0 and 15. * The `comparator` param must be a string defining a valid [Comparator Mode](/custom-machinery-1.16/misc/comparator.md). \ Default : `>=`
Light **Use one of these methods to add a** [**Light Requirement**](/custom-machinery-1.16/recipes/requirements/light.md) **to the recipe.** ```java .requireSkyLight(int amount) .requireSkyLight(int amount, String comparator) .requireBlockLight(int amount) .requireBlockLight(int amount, String comparator) ``` * The `amount` param must be a positive integer between 0 and 15. * The `comparator` param must be a string defining a valid [Comparator Mode](/custom-machinery-1.16/misc/comparator.md). \ Default : `>=`
Entity **Use one of these methods to add an** [**Entity Requirement**](/custom-machinery-1.16/recipes/requirements/entity.md) **to the recipe.** ```java .requireEntities(int amount, int radius, Entity[] filter, boolean whitelist) .requireEntityHealth(int amount, int radius, Entity[] filter, boolean whitelist) .consumeEntityHeathOnStart(int amount, int radius, Entity[] filter, boolean whitelist) .consumeEntityHealthOnEnd(int amount, int radius, Entity[] filter, boolean whitelist) .killEntitiesOnStart(int amount, int radius, Entity[] filter, boolean whitelist) .killEntitiesOnEnd(int amount, int radius, Entity[] filter, boolean whitelist) ``` * The `amount` and `radius` params must be a positive integer. * The `filter` param must be an array of [entity types](https://docs.blamejared.com/1.16/en/vanilla/api/BracketHandlers/#g-getentitytype). Example : `[, "...]` Default : `[]` * The `whitelist` param must be a boolean, if true the filter will be a whitelist, if false it will be a blacklist.
Block **Use one of these methods to add a** [**Block Requirement**](/custom-machinery-1.16/recipes/requirements/block.md) **to the recipe.** ```java .requireBlock(filter, whitelist, startX, startY, startZ, endX, endY, endZ) .requireBlock(filter, whitelist, startX, startY, startZ, endX, endY, endZ, amount) .requireBlock(filter, whitelist, startX, startY, startZ, endX, endY, endZ, amount, comparator) .placeBlockOnStart("block", startX, startY, startZ, endX, endY, endZ) .placeBlockOnStart("block", startX, startY, startZ, endX, endY, endZ, amount) .placeBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ) .placeBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ, amount) .breakAndPlaceBlockOnStart("block", startX, startY, startZ, endX, endY, endZ) .breakAndPlaceBlockOnStart("block", startX, startY, startZ, endX, endY, endZ, amount) .breakAndPlaceBlockOnStart("block", startX, startY, startZ, endX, endY, endZ, amount, filter) .breakAndPlaceBlockOnStart("block", startX, startY, startZ, endX, endY, endZ, amount, filter, whitelist) .breakAndPlaceBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ) .breakAndPlaceBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ, amount) .breakAndPlaceBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ, amount, filter) .breakAndPlaceBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ, amount, filter, whitelist) .destroyAndPlaceBlockOnStart("block", startX, startY, startZ, endX, endY, endZ) .destroyAndPlaceBlockOnStart("block", startX, startY, startZ, endX, endY, endZ, amount) .destroyAndPlaceBlockOnStart("block", startX, startY, startZ, endX, endY, endZ, amount, filter) .destroyAndPlaceBlockOnStart("block", startX, startY, startZ, endX, endY, endZ, amount, filter, whitelist) .destroyAndPlaceBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ) .destroyAndPlaceBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ, amount) .destroyAndPlaceBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ, amount, filter) .destroyAndPlaceBlockOnEnd("block", startX, startY, startZ, endX, endY, endZ, amount, filter, whitelist) .destroyBlockOnStart(filter, whitelist, startX, startY, startZ, endX, endY, endZ) .destroyBlockOnStart(filter, whitelist, startX, startY, startZ, endX, endY, endZ, amount) .destroyBlockOnEnd(filter, whitelist, startX, startY, startZ, endX, endY, endZ) .destroyBlockOnEnd(filter, whitelist, startX, startY, startZ, endX, endY, endZ, amount) .breakBlockOnStart(filter, whitelist, startX, startY, startZ, endX, endY, endZ) .breakBlockOnStart(filter, whitelist, startX, startY, startZ, endX, endY, endZ, amount) .breakBlockOnEnd(filter, whitelist, startX, startY, startZ, endX, endY, endZ) .breakBlockOnEnd(filter, whitelist, startX, startY, startZ, endX, endY, endZ, amount) ``` * The `block` param must be a string defining a valid blockstate.\ Using the format `namespace:block_id[property1=value1,property2=value2...]{tag1: value1, tag2: value2...}` (The \[] and {} are optional)\ This is the block that will be placed. * The `filter` param must be an arrays of string defining a valid blockstate.\ This is the blocks that the machine can/can't break depending on the whitelist property. * The `whitelist` param must be a boolean, if true the filter property will be a whitelist, if false a blacklist. Default to false when not specified. * The `startX`, `startY`, `startZ`, `endX`, `endY`, `endZ` must be integer values defining the box where the machine will search for blocks.\ You can use the in-game `Box Creator` to select a box and put the values here. * The `amount` param must be a positive integer. \ Default : `1` * The `comparator` param must be a string defining a valid [Comparator Mode](/custom-machinery-1.16/misc/comparator.md). \ Default : `==`
Structure **Use this method to add a** [**Structure Requirement**](/custom-machinery-1.16/recipes/requirements/structure.md) **to the recipe.** ```java .requireStructure(String[][] pattern, Map keys) ``` * The `pattern` param must be an array of array of strings. \ See `pattern` property of structure requirement.\ Example: `[["aaa", "aaa", "aaa"], ["aaa", "ama", "aaa"], ["aaa", "aaa", "aaa"]]` Define a 3x3x3 box around the machine `m` * The `keys` param must be a map of string -> string. \ See `keys` property of structure requirement.\ The keys of the map must be single characters (except `m` which is reserved for the machine) and the values must be a block ID with the format: `namespace:block_id[state1=value,state2=value]` (states are optional).\ Example: `{"a": "minecraft:stone", "b": "minecraft:diamond_block"}` **Example** ```java .requireStructure([[ "aaa", "a a", "aaa", " m " ]], {"a": "minecraft:stone"}) ``` A 3x1x3 hollow ring of stone behind the machine.
Loot Table **Use one of these methods to add a** [**Loot Table Requirement**](/custom-machinery-1.16/recipes/requirements/loot-table.md) **to the recipe.** ```java .lootTableOutput(String loot_table) .lootTableOutput(String loot_table, float luck) ``` * The `loot_table` param must be a string path that point to a loot table. The loot table file must be loaded with a datapack or a loader mod.\ Example: `custommachinery:my_test_loottable` point to a file in `data/custommachinery/loot_tables/my_test_loottable.json` * The `luck` param must be a float. \ Default is 0.0 and it can be used in the loot table to alter the quantity of generated items.
Drop **Use one of these methods to add a** [**Drop Requirement**](/custom-machinery-1.16/recipes/requirements/drop.md) **to the recipe.** ```java //Check for a specific item. .checkDrop(IItemStack item, int amount, int radius) //Check for any item. .checkAnyDrop(int amount, int radius) //Check for a list of items. .checkDrops(IItemStack[] filter, int amount, int radius) .checkDrops(IItemStack[] filter, int amount, int radius, boolean whitelist) .consumeDropOnStart(IItemStack item, int amount, int radius) //Consume any drop at the end of the recipe. .consumeDropOnStart(int amount, int radius) .consumeDropsOnStart(IItemStack[] filter, int amount, int radius) .consumeDropsOnStart(IItemStack[] filter, int amount, int radius, boolean whitelist) .consumeDropOnEnd(IItemStack item, int amount, int radius) //Consume any drop at the end of the recipe. .consumeDropOnEnd(int amount, int radius) .consumeDropsOnEnd(IItemStack[] filter, int amount, int radius) .consumeDropsOnEnd(IItemStack[] filter, int amount, int radius, boolean whitelist) .dropItemOnStart(IItemStack item) .dropItemOnEnd(IItemStack item) ``` * The `item` param must be an [IItemStack](https://docs.blamejared.com/1.16/en/vanilla/api/items/IItemStack/). \ Example : ` * 5` * The `amount` param must be a positive integer, it represents the amount of items checked/consumed. * The `radius` param must be a positive integer, it represents the maximum distance to the machine the items will be searched. * The `filter` param must be an array of [IItemStack](https://docs.blamejared.com/1.16/en/vanilla/api/items/IItemStack/). \ Example : `[ * 5, ]`. \ It represents a whitelist of items to search. * The `whitelist` param must be a boolean, if set to `false` the filter will be a blacklist instead of a whitelist.
Function **Use one of these methods to add a function that must be processed by the machine to continue the recipe.** Note: This has nothing to do with MC functions (or commands), this requirement allow you to make your own code in ZenScript and pass it to be executed by the machine. ```java //These imports are needed, put these 3 lines on top of the script. import mods.custommachinery.Context; import mods.custommachinery.Result; import mods.custommachinery.Machine; //Executed when the machine is idle and search a recipe to process. //Returning success will allow the machine to process this recipe (if all other requirements allow it as well). //Returning error will prevent the machine to process this recipe (the machine will keep searching for another valid recipe). .requireFunctionToStart((ctx as Context) => {return Result.success()}) //Executed the first tick of the crafting process. //Returning success will allow the machine to continue to process this recipe. //Returning error will put the machine in error status and display the provided error message. .requireFunctionOnStart((ctx as Context) => {return Result.success()}) //Executed each tick of the crafting process. //Returning success will allow the machine to continue to process this recipe. //Returning error will put the machine in error status and display the provided error message. .requireFunctionEachTick((ctx as Context) => {return Result.success()}) //Executed the last tick of the crafting process. //Returning success will allow the machine to continue to process this recipe. //Returning error will put the machine in error status and display the provided error message. .requireFunctionOnEnd((ctx as Context) => {return Result.success()}) ``` * The passed function MUST return a Result. * Valid results are : `Result.success()` and `Result.error("Error message")` * Context has various methods for interacting with the machine, see [it's wiki page](/custom-machinery-1.16/mod-integrations/crafttweaker/recipes/context.md) * The function can be delayed, put `.delay(delay)` directly after any `.requireFunctionXXX()` call to make the function be executed at the specified delay. Example : ```java import mods.custommachinery.Context; import mods.custommachinery.Result; import mods.custommachinery.Machine; mods.custommachinery.CMRecipeBuilder.create("custommachinery:power_crusher", 100) .requireFunctionOnEnd((ctx as Context) => { var machine = ctx.machine as Machine; var output = machine.addItemToSlot("output1", , false); if(!output.empty) return Result.error("Couldn't put a diamond in output slot."); else return Result.success(); }) .build(); ```
### Requirements special properties Some requirements (almost all) have various properties that can change its behaviour. To set these properties you must call one or several of the methods below **immediatly after** the desired requirement. The properties will only be applied on the latest added requirement when the method is called. If the latest added requirement doesn't support the property an error will be logged and nothing will happen (the property will be ignored).
Chance **Use this method to add a `chance` property to the latest added requirement.** ```java .chance(double chance) ``` * The `chance` param must be a double between 0.0 and 1.0 included. **Supported requirements :** * Command * Drop * Durability * Energy * Energy Per Tick * Fluid * Fluid Per Tick * Item
Delay **Use this method to set a delay for the requirement action.** The requirement will only execute its action after the specified delay. ```java .delay(double delay) ``` * The `delay` param must be a double between 0.0 and 1.0 excluded. 0 represent the start of the recipe and 1 represent its end. **Supported requirements :** * Block * Command * Drop * Function
### Priority Use the method below to set the priority of the recipe. If this method is called several times only the latest will be used. If this is called **AFTER** `.jei()` (no need to be immediately after) this will act as the "jeiPriority" instead, defining the priority of the recipe to show in jei instead of the priority to be checked in the machine. If no priority is set, the default value : `0` will be used. ```java .priority(priority) ``` * The `priority` param must be an integer value. ### Jei If the method below is called, all requirements added after that will be added to the `jei` property requirement list. ```java .jei() ``` This action cannot be inverted, you must add all your recipe requirements before calling it. Requirements added after this method will only be displayed in jei but executed by the machine. Learn more [here](/custom-machinery-1.16/recipes/creating-a-recipe.md#optional-properties). ### Examples :
Example 1 **A 100 tick recipe that use 5mB of water, 5mB of any fluid with tag lava and 20FE per tick to create a stone.** ```java mods.custommachinery.CMRecipeBuilder.create("custommachinery:stone_generator", 100) .requireFluid( * 5) .requireFluidTag(, 5) .requireEnergyPerTick(20) .produceItem() .build(); ``` example_recipe_1
Example 2 **A 200 tick recipe that use 1 item with tag stone and 20FE per tick to create 1 cobblestone, 1 gravel with 50% chance and 1 sand with 10% chance.** ```java mods.custommachinery.CMRecipeBuilder.create("custommachinery:power_crusher", 200) .requireItemTag(, 1) .requireEnergyPerTick(20) .produceItem() .produceItem().chance(0.5) .produceItem().chance(0.1) .build(); ``` example_recipe_2
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://frinn.gitbook.io/custom-machinery-1.16/mod-integrations/crafttweaker/recipes.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.