Recipes

Create machine recipes using KubeJS

Custom Machine recipes can be made with KubeJS.

Create a .js file in the kubejs/server_scripts/ folder (ex: custom_machine_recipes.js).

Then inside the .js file you can use the recipes kubejs event to get 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).

ServerEvents.recipes(event => {
  //Machine recipe : 
  event.recipes.custommachinery.custom_machine("namespace:machine_id", duration)
  //Add requirements here
  
  //Craft recipe : 
  event.recipes.custommachinery.custom_craft("namespace:machine_id", "output_item")
  //Add requirements here
})

Requirements

You can add various requirements on the custom machine recipe builder :

BiomeBlockChemical (Mekanism)CommandContraption (Create)DimensionDropDurabilityEffectEnergyEntityFluidFuelFunctionHeat (Mekanism)ItemItem transformLightLoot tablePositionRadiation (Mekanism)RedstoneSkyStructureTimeWeatherWorking core

Requirements special properties

Some requirements (almost all) have various properties that can change its behavior.

To set these properties you must call one or several of the methods below immediately 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.

.chance(chance)

• The chance param must be a double between 0.0 and 1.0 included.

Supported requirements :

• Block

• Command

• Drop

• Durability

• Effect

• Energy

• Energy Per Tick

• Entity

• Fluid

• Fluid Per Tick

• Function

• Item

Delay

Use this method to set a delay for the requirement action.

The requirement will only execute its action after the specified delay.

.delay(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

• Effect

• Entity

• Function

Display info

Specify a custom requirement display info by calling the following method after a requirement :

.info(info => info
    //Add a new tooltip line
    .tooltip("A new tooltip")
    //This line will be displayed for creative players only
    .tooltip("Creative only", TooltipPredicate.CREATIVE)
    //This line will be displayed for players with F3+H only
    .tooltip("Advanced debug info only", TooltipPredicate.ADVANCED)
    //Use an item as icon
    .item("minecraft:diamond")
    //Use one of these 3 methods to specify a texture as icon
    .texture("texture_path")
    .texture("texture_path", width, height)
    .texture("texture_path", width, height, u, v)
    //Use a sprite as icon
    .sprite("atlas_path", "sprite_id")
)

Example : Add a diamond icon with a tooltip

.info(info => info.tooltip("This recipe make diamonds").item("minecraft:diamond"))

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 immediatly 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.

.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.

.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 not executed by the machine. Learn more here.

Reset on error

If the method below is called, the recipe will reset the machine instead of erroring when a requirement throw an error.

.resetOnError()

Note : When the machine is reset its inventory remains the same, but all already consumed inputs are lost.

Hide in JEI

Call the following method anywhere in your recipe builder to make the recipe hidden in JEI.

The recipe will still work in the machine but won't show in JEI.

.hide()

Custom machine appearance

The following methods allow you to set a custom machine appearance that will be applied on the machine while this recipe is processing.

Each of the following properties are optional, just call those you need.

.appearance(builder => builder
        .block('block_id')
        .item('item_id') //Useless
        .ambientSound('sound_id')
        .ambientSound('sound_id', volume, pitch)
        .ambientSound('sound_id', volume, pitch, source, loop, attenuation, delay, relative) 
        .interactionSound('block_id')
        .light(light_level) //Between 0 and 15
        .color(color_integer) //Only integer color here
        .hardness(hardness) //Can be -1 for unbreakable
        .resistance(resistance)
        .tooltype('tool_type') //Must be a block tag id
        .miningLevel('mining_level') //Must be a block tag id
        .requiresTool(required) //True/False

Custom machine gui

The following method allows you to add or replace some of the machine's gui elements while this recipe is processing.

.gui([...])//Replace '...' by your gui elements.

Any gui element from CM and its addons can be used here.

When a machine process this recipe, all gui elements defined here will be added to the machine gui.

If a gui element defined here has the same id than another element defined in the machine json then it will replace it.

It is impossible to remove a gui element defined in the machine json, but you can replace it with an empty gui element instead.

Example :

Change the position of a slot gui element with id "input1", and replace the gui element with id "texture" by an empty gui element :

.gui([
    {
        "type": "custommachinery:slot",
        "x": 10,
        "y": 10,
        "id": "input1"
    },
    {
       "type": "custommachinery:empty",
       "id": "texture"
    }
])

Parallel processing

As of CM 0.10.5 recipes multiple recipes can now run in parallel.

This is only possible using the Machine Processor and by setting its "amount" property higher than 1.

By default the recipe will try to run on any cores, and on as much cores as possible.

This can be changed using one of these methods :

//Specify on which cores the recipe can run, several cores can be specified.
//Cores are defined by an integer, where 1 is the first core.
.cores(1)
.cores([1, 2, 3])

//Set the recipe to run only on 1 core at a time.
.singleCore()

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.

ServerEvents.recipes(event => {

  event.recipes.custommachinery.custom_machine("custommachinery:stone_generator", 100)
  .requireFluid("5x minecraft:water")
  .requireFluid("5x #minecraft:lava")
  .requireEnergyPerTick(20)
  .produceItem("minecraft:stone")
})

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.

ServerEvents.recipes(event => {

  event.recipes.custommachinery.custom_machine("custommachinery:power_crusher", 200)
  .requireItem("#forge:stone")
  .requireEnergyPerTick(20)
  .produceItem("minecraft:cobblestone")
  .produceItem("minecraft:gravel").chance(0.5)
  .produceItem("minecraft:sand").chance(0.1)
})