The current recipe system relies on copying recipe config files from the mod jar to the config directory, so that they can be modified by users. Dynamic recipes, which are generated depending on present mods, are also saved and modifiable.
However, this approach introduces severe migration issues:
Adding/removing mods will not regenerate dynamic recipes
Removing mods may invalidate some existing dynamic recipes, resulting in a crash
Updated base GTE recipes are not copied to the config dir, and end up being ignored
These problems may appear very frustrating to users and make the pack making experience less friendly.
The Solution
We remove the current file copy system as well as caching dynamic recipes. Instead, base recipes will be loaded from the mod jar and dynamic recipes will always be generated at runtime. Rather than modifying the files directly, pack makers will be able to tweak GTE's recipes via CraftTweaker.
Modders can keep using the programmatic interface which can be aquired by calling IGregTechAPI#getRecipeFactory for recipes and IGregTechAPI#getFuelFactory for fuels respectively.
CraftTweaker support documentation
Recipes
Each recipe support class contains methods for adding and removing recipes, including variants with optional parameters. A lot of parameter types are resused so I'll briefly explain the common ones to avoid duplicate docs:
IIngredient input: A single ingredient representing one input slot. It may come in an IIngredient[] array variant as well for multi input recipes.
IItemStack output: A single output ItemStack representing one output slot. It may come in an IItemStack[] array variant as well for multi output recipes.
int duration: The time it takes to process the recipe in ticks.
double energyCost: The recipe's EU/t energy cost.
boolean universal: Add this recipe to similar machines from other mods as well.
Removing recipes
I mean, you can only remove things once they're registered, right?
While adding recipes doesn't require any additional configuration, removing them needs to be handled separately.
It's very important you use the gregtechmod loader for removing recipes. This loader only loads the script after GTE finished registering all of its recipes in post-init. You can apply it to your script by using the loader preprocessor:
#loader gregtechmod
Invididual machine Zen methods
### Alloy Smelter
#### Zen Class
`mods.gregtechmod.AlloySmelter`
#### Methods
```java
void addRecipe(IIngredient[] inputs, IItemStack output, int duration, @Optional double energyCost, @Optional boolean universal)
```
```java
void removeRecipe(IItemStack[] inputs)
```
### Assembler
#### Zen Class
`mods.gregtechmod.Assembler`
#### Methods
```java
void addRecipe(IIngredient[] inputs, IItemStack output, int duration, @Optional double energyCost)
```
```java
void removeRecipe(IItemStack[] inputs)
```
### Bending Machine
#### Zen Class
`mods.gregtechmod.Bender`
#### Methods
```java
void addRecipe(IIngredient input, IItemStack output, int duration, double energyCost)
```
```java
void removeRecipe(IItemStack input)
```
### Automatic Canning Machine
#### Zen Class
`mods.gregtechmod.Canner`
#### Methods
```java
void addRecipe(IIngredient[] inputs, IItemStack[] outputs, int duration, double energyCost)
```
```java
void removeRecipe(IItemStack[] inputs)
```
### Chemical Reactor
#### Zen Class
`mods.gregtechmod.ChemicalReactor`
#### Methods
```java
void addRecipe(IIngredient[] inputs, IItemStack outputs, int duration)
```
```java
void removeRecipe(IItemStack[] inputs)
```
### Distillation Tower
#### Zen Class
`mods.gregtechmod.DistillationTower`
#### Methods
Parameter `int cells`: The amount of cells required for processing the recipe.
```java
void addRecipe(IIngredient input, IItemStack[] outputs, int cells, int duration)
```
```java
void removeRecipe(ILiquidStack input)
```
```java
void removeRecipe(ILiquidStack input, int cells)
```
```java
void removeRecipe(IItemStack input)
```
```java
void removeRecipe(IItemStack input, int cells)
```
### Fusion Reactor
#### Zen Class
`mods.gregtechmod.FusionReactor`
#### Methods
Parameter `double startEnergy`: The amount of EU required to start the reactor. Subsequent processing of the same recipe does not require it.
```java
void addRecipe(IIngredient[] inputs, ILiquidStack output, int duration, double energyCost, double startEnergy)
```
```java
void addRecipe(IIngredient[] inputs, IItemStack output, int duration, double energyCost, double startEnergy)
```
```java
void removeRecipe(ILiquidStack[] inputs)
```
```java
void removeRecipe(ILiquidStack[] inputs)
```
### Implosion Compressor
#### Zen Class
`mods.gregtechmod.ImplosionCompressor`
#### Methods
Parameter `int tnt`: The amount of Industrial TNT required to process the recipe.
```java
void addRecipe(IIngredient input, int tnt, IItemStack[] outputs)
```
```java
void removeRecipe(IItemStack input, int tnt)
```
### Industrial Blast Furnace
#### Zen Class
`mods.gregtechmod.IndustrialBlastFurnace`
#### Methods
Parameter `int heat`: The required amount of Blast Furnace heat capacity to process the recipe.
```java
void addRecipe(IIngredient[] inputs, IItemStack[] outputs, int duration, int heat, @Optional boolean universal)
```
```java
void addRecipe(IIngredient[] inputs, IItemStack[] outputs, int duration, double energyCost, int heat, @Optional boolean universal)
```
```java
void removeRecipe(IItemStack[] inputs)
```
### Industrial Centrifuge
#### Zen Class
`mods.gregtechmod.IndustrialCentrifuge`
#### Methods
Parameter `int cells`: The amount of cells required to process the recipe.
```java
void addRecipe(IIngredient input, IItemStack[] outputs, int cells, int duration, @Optional CTCellType cellType)
```
```java
void removeRecipe(ILiquidStack input)
```
```java
void removeRecipe(ILiquidStack input, int cells)
```
```java
void removeRecipe(IItemStack input)
```
```java
void removeRecipe(IItemStack input, int cells)
```
### Industrial Electrolyzer
#### Zen Class
`mods.gregtechmod.IndustrialElectrolyzer`
#### Methods
Parameter `int cells`: The amount of cells required to process the recipe.
```java
void addRecipe(IIngredient input, IItemStack[] outputs, int cells, int duration, @Optional(valueDouble = 128) double energyCost)
```
```java
void removeRecipe(ILiquidStack input)
```
```java
void removeRecipe(ILiquidStack input, int cells)
```
```java
void removeRecipe(IItemStack input)
```
```java
void removeRecipe(IItemStack input, int cells)
```
### Industrial Grinder
#### Zen Class
`mods.gregtechmod.IndustrialGrinder`
#### Methods
```java
void addRecipe(IIngredient input, ILiquidStack fluid, IItemStack[] output)
```
```java
void removeRecipe(IItemStack input, ILiquidStack fluid)
```
### Industrial Sawmill
#### Zen Class
`mods.gregtechmod.IndustrialSawmill`
#### Methods
Parameter `int water`: Buckets of water required to process the recipe.
```java
void addRecipe(IIngredient input, IItemStack[] outputs, @Optional int water, @Optional boolean universal)
```
```java
void removeRecipe(IItemStack input, ILiquidStack fluid)
```
### Lathe
#### Zen Class
`mods.gregtechmod.Lathe`
#### Methods
```java
void addRecipe(IIngredient input, IItemStack[] outputs, int duration, @Optional(valueDouble = RecipeLathe.DEFAULT_ENERGY_COST) double energyCost)
```
```java
void removeRecipe(IItemStack input)
```
### Printer
#### Zen Class
`mods.gregtechmod.Printer`
#### Methods
```java
void addRecipe(IIngredient[] inputs, IItemStack output, int duration, @Optional double energyCost)
```
```java
void addRecipe(IIngredient[] inputs, @Nullable IIngredient copy, IItemStack output, int duration, @Optional double energyCost)
```
```java
void removeRecipe(IItemStack[] inputs)
```
### Vacuum Freezer
#### Zen Class
`mods.gregtechmod.VacuumFreezer`
#### Methods
```java
void addRecipe(IIngredient input, IItemStack output, int duration, double energyCost)
```
```java
void removeRecipe(IItemStack input)
```
### Wiremill
#### Zen Class
`mods.gregtechmod.Wiremill`
#### Methods
```java
void addRecipe(IIngredient input, IItemStack output, int duration, double energyCost)
```
```java
void removeRecipe(IItemStack input)
```
Fuels
Same rules apply as for adding/removing recipes.
Methods
Parameters:
IIngredient input: The fuel input. May be an item and/or fluid depending on the fuel type.
double energy: The EU generated by this fuel per tick.
### Dense Liquid
`mods.gregtechmod.fuel.DenseLiquid`
Used in the Semifluid generator.
### Diesel
`mods.gregtechmod.fuel.Diesel`
Used in the Diesel generator.
### Gas
`mods.gregtechmod.fuel.Gas`
Used in Gas turbines.
### Magic
`mods.gregtechmod.fuel.Magic`
Used in the Magic Energy Converter.
### Plasma
`mods.gregtechmod.fuel.Plasma`
Used in the Plasma Generator.
### Steam
`mods.gregtechmod.fuel.Steam`
Used in the Large Steam Turbine, as well as the Steam Engine upgrade.
OreDict
mods.gregtechmod.OreDict
Utility methods for modifying the OreDictHandler, which is used to generate dynamic recipes.
Invididual oredict Zen methods
### Ore Aliases
Alias an oredict entry name.
```java
void addOreAlias(String ore, String alias)
```
```java
removeOreAlias(String ore)
```
### Valuable Ores
Modify values in IC2's `OreValues` class, which are then used in the Miner and ore Scanner.
```java
void addValuableOre(String ore, int value)
```
```java
void removeValuableOre(String ore)
```
### Ignored names
Exclude an oredict entry from `OreDictHandler`.
```java
void addIgnoredName(String ore)
```
```java
void removeIgnoredName(String ore)
```
Zen Utilities
Fluid Cell Bracket Handler
GTE adds a custom bracket handler that returns a fluid cell IItemStack for the current IC2 profile. You can use it by calling <fluid_cell:fluid_name>, where fluid_name is the name of the desired fluid.
Custom damage setter
Items that implement ICustomDamageItem (electric items, reactor coolant cells etc.) have a separate way of handling item damage and traditional methods such as setItemDamage don't have any effect on them. Instead, you need to call interface specific methods. For this purpose, GTE extends IItemStack with 2 new functions:
IItemStack anyCustomDamage(IItemStack stack): Sets the stack's custom damage to the wildcard value
IItemStack withCustomDamage(IItemStack stack, int damage): Sets the stack's custom damage to the specified value
The Issue
The current recipe system relies on copying recipe config files from the mod jar to the config directory, so that they can be modified by users. Dynamic recipes, which are generated depending on present mods, are also saved and modifiable.
However, this approach introduces severe migration issues:
The Solution
We remove the current file copy system as well as caching dynamic recipes. Instead, base recipes will be loaded from the mod jar and dynamic recipes will always be generated at runtime. Rather than modifying the files directly, pack makers will be able to tweak GTE's recipes via CraftTweaker.
Modders can keep using the programmatic interface which can be aquired by calling
IGregTechAPI#getRecipeFactoryfor recipes andIGregTechAPI#getFuelFactoryfor fuels respectively.CraftTweaker support documentation
Recipes
Each recipe support class contains methods for adding and removing recipes, including variants with optional parameters. A lot of parameter types are resused so I'll briefly explain the common ones to avoid duplicate docs:
IIngredient input: A single ingredient representing one input slot. It may come in anIIngredient[]array variant as well for multi input recipes.IItemStack output: A single outputItemStackrepresenting one output slot. It may come in anIItemStack[]array variant as well for multi output recipes.int duration: The time it takes to process the recipe in ticks.double energyCost: The recipe's EU/t energy cost.boolean universal: Add this recipe to similar machines from other mods as well.Removing recipes
I mean, you can only remove things once they're registered, right?
While adding recipes doesn't require any additional configuration, removing them needs to be handled separately.
It's very important you use the
gregtechmodloader for removing recipes. This loader only loads the script after GTE finished registering all of its recipes in post-init. You can apply it to your script by using the loader preprocessor:
### Alloy Smelter #### Zen Class `mods.gregtechmod.AlloySmelter` #### Methods ```java void addRecipe(IIngredient[] inputs, IItemStack output, int duration, @Optional double energyCost, @Optional boolean universal) ``` ```java void removeRecipe(IItemStack[] inputs) ``` ### Assembler #### Zen Class `mods.gregtechmod.Assembler` #### Methods ```java void addRecipe(IIngredient[] inputs, IItemStack output, int duration, @Optional double energyCost) ``` ```java void removeRecipe(IItemStack[] inputs) ``` ### Bending Machine #### Zen Class `mods.gregtechmod.Bender` #### Methods ```java void addRecipe(IIngredient input, IItemStack output, int duration, double energyCost) ``` ```java void removeRecipe(IItemStack input) ``` ### Automatic Canning Machine #### Zen Class `mods.gregtechmod.Canner` #### Methods ```java void addRecipe(IIngredient[] inputs, IItemStack[] outputs, int duration, double energyCost) ``` ```java void removeRecipe(IItemStack[] inputs) ``` ### Chemical Reactor #### Zen Class `mods.gregtechmod.ChemicalReactor` #### Methods ```java void addRecipe(IIngredient[] inputs, IItemStack outputs, int duration) ``` ```java void removeRecipe(IItemStack[] inputs) ``` ### Distillation Tower #### Zen Class `mods.gregtechmod.DistillationTower` #### Methods Parameter `int cells`: The amount of cells required for processing the recipe. ```java void addRecipe(IIngredient input, IItemStack[] outputs, int cells, int duration) ``` ```java void removeRecipe(ILiquidStack input) ``` ```java void removeRecipe(ILiquidStack input, int cells) ``` ```java void removeRecipe(IItemStack input) ``` ```java void removeRecipe(IItemStack input, int cells) ``` ### Fusion Reactor #### Zen Class `mods.gregtechmod.FusionReactor` #### Methods Parameter `double startEnergy`: The amount of EU required to start the reactor. Subsequent processing of the same recipe does not require it. ```java void addRecipe(IIngredient[] inputs, ILiquidStack output, int duration, double energyCost, double startEnergy) ``` ```java void addRecipe(IIngredient[] inputs, IItemStack output, int duration, double energyCost, double startEnergy) ``` ```java void removeRecipe(ILiquidStack[] inputs) ``` ```java void removeRecipe(ILiquidStack[] inputs) ``` ### Implosion Compressor #### Zen Class `mods.gregtechmod.ImplosionCompressor` #### Methods Parameter `int tnt`: The amount of Industrial TNT required to process the recipe. ```java void addRecipe(IIngredient input, int tnt, IItemStack[] outputs) ``` ```java void removeRecipe(IItemStack input, int tnt) ``` ### Industrial Blast Furnace #### Zen Class `mods.gregtechmod.IndustrialBlastFurnace` #### Methods Parameter `int heat`: The required amount of Blast Furnace heat capacity to process the recipe. ```java void addRecipe(IIngredient[] inputs, IItemStack[] outputs, int duration, int heat, @Optional boolean universal) ``` ```java void addRecipe(IIngredient[] inputs, IItemStack[] outputs, int duration, double energyCost, int heat, @Optional boolean universal) ``` ```java void removeRecipe(IItemStack[] inputs) ``` ### Industrial Centrifuge #### Zen Class `mods.gregtechmod.IndustrialCentrifuge` #### Methods Parameter `int cells`: The amount of cells required to process the recipe. ```java void addRecipe(IIngredient input, IItemStack[] outputs, int cells, int duration, @Optional CTCellType cellType) ``` ```java void removeRecipe(ILiquidStack input) ``` ```java void removeRecipe(ILiquidStack input, int cells) ``` ```java void removeRecipe(IItemStack input) ``` ```java void removeRecipe(IItemStack input, int cells) ``` ### Industrial Electrolyzer #### Zen Class `mods.gregtechmod.IndustrialElectrolyzer` #### Methods Parameter `int cells`: The amount of cells required to process the recipe. ```java void addRecipe(IIngredient input, IItemStack[] outputs, int cells, int duration, @Optional(valueDouble = 128) double energyCost) ``` ```java void removeRecipe(ILiquidStack input) ``` ```java void removeRecipe(ILiquidStack input, int cells) ``` ```java void removeRecipe(IItemStack input) ``` ```java void removeRecipe(IItemStack input, int cells) ``` ### Industrial Grinder #### Zen Class `mods.gregtechmod.IndustrialGrinder` #### Methods ```java void addRecipe(IIngredient input, ILiquidStack fluid, IItemStack[] output) ``` ```java void removeRecipe(IItemStack input, ILiquidStack fluid) ``` ### Industrial Sawmill #### Zen Class `mods.gregtechmod.IndustrialSawmill` #### Methods Parameter `int water`: Buckets of water required to process the recipe. ```java void addRecipe(IIngredient input, IItemStack[] outputs, @Optional int water, @Optional boolean universal) ``` ```java void removeRecipe(IItemStack input, ILiquidStack fluid) ``` ### Lathe #### Zen Class `mods.gregtechmod.Lathe` #### Methods ```java void addRecipe(IIngredient input, IItemStack[] outputs, int duration, @Optional(valueDouble = RecipeLathe.DEFAULT_ENERGY_COST) double energyCost) ``` ```java void removeRecipe(IItemStack input) ``` ### Printer #### Zen Class `mods.gregtechmod.Printer` #### Methods ```java void addRecipe(IIngredient[] inputs, IItemStack output, int duration, @Optional double energyCost) ``` ```java void addRecipe(IIngredient[] inputs, @Nullable IIngredient copy, IItemStack output, int duration, @Optional double energyCost) ``` ```java void removeRecipe(IItemStack[] inputs) ``` ### Vacuum Freezer #### Zen Class `mods.gregtechmod.VacuumFreezer` #### Methods ```java void addRecipe(IIngredient input, IItemStack output, int duration, double energyCost) ``` ```java void removeRecipe(IItemStack input) ``` ### Wiremill #### Zen Class `mods.gregtechmod.Wiremill` #### Methods ```java void addRecipe(IIngredient input, IItemStack output, int duration, double energyCost) ``` ```java void removeRecipe(IItemStack input) ```Invididual machine Zen methods
Fuels
Same rules apply as for adding/removing recipes.
Methods
Parameters:
IIngredient input: The fuel input. May be an item and/or fluid depending on the fuel type.double energy: The EU generated by this fuel per tick.IItemStack output: Optional outputItemStack.
### Dense Liquid `mods.gregtechmod.fuel.DenseLiquid` Used in the Semifluid generator. ### Diesel `mods.gregtechmod.fuel.Diesel` Used in the Diesel generator. ### Gas `mods.gregtechmod.fuel.Gas` Used in Gas turbines. ### Magic `mods.gregtechmod.fuel.Magic` Used in the Magic Energy Converter. ### Plasma `mods.gregtechmod.fuel.Plasma` Used in the Plasma Generator. ### Steam `mods.gregtechmod.fuel.Steam` Used in the Large Steam Turbine, as well as the Steam Engine upgrade.Invididual fuel Zen class identifiers and usages
OreDict
mods.gregtechmod.OreDictUtility methods for modifying the
OreDictHandler, which is used to generate dynamic recipes.
### Ore Aliases Alias an oredict entry name. ```java void addOreAlias(String ore, String alias) ``` ```java removeOreAlias(String ore) ``` ### Valuable Ores Modify values in IC2's `OreValues` class, which are then used in the Miner and ore Scanner. ```java void addValuableOre(String ore, int value) ``` ```java void removeValuableOre(String ore) ``` ### Ignored names Exclude an oredict entry from `OreDictHandler`. ```java void addIgnoredName(String ore) ``` ```java void removeIgnoredName(String ore) ```Invididual oredict Zen methods
Zen Utilities
Fluid Cell Bracket Handler
GTE adds a custom bracket handler that returns a fluid cell
IItemStackfor the current IC2 profile. You can use it by calling<fluid_cell:fluid_name>, wherefluid_nameis the name of the desired fluid.Custom damage setter
Items that implement
ICustomDamageItem(electric items, reactor coolant cells etc.) have a separate way of handling item damage and traditional methods such assetItemDamagedon't have any effect on them. Instead, you need to call interface specific methods. For this purpose, GTE extendsIItemStackwith 2 new functions:IItemStack anyCustomDamage(IItemStack stack): Sets the stack's custom damage to the wildcard valueIItemStack withCustomDamage(IItemStack stack, int damage): Sets the stack's custom damage to the specified valueExamples!
Because we love examples.
You can find examples for most ZS methods here.