Skip to content

Refactor JEI description, add support for fluids #382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Wizzerinus wants to merge 3 commits into
base: master
Choose a base branch
from
+149 −41
Open

Refactor JEI description, add support for fluids #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f94b4c
Add support for fluids in JEI description
Wizzerinus Apr 11, 2026
bebadea
remove prints
Wizzerinus Apr 12, 2026
53b5d53
generics
Wizzerinus Apr 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion examples/postInit/generated/jei_generated.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,12 @@ mods.jei.category.hideCategory('minecraft.fuel')
// Description Category:
// Modify the description of the input items, where the description is a unique JEI tab containing text.

// mods.jei.description.remove(fluid('water'))
// mods.jei.description.remove(item('thaumcraft:triple_meat_treat'))

mods.jei.description.add(item('minecraft:gold_ingot'), 'groovyscript.recipe.fluid_recipe')
mods.jei.description.add(fluid('water') * 1000, 'groovyscript.recipe.fluid_recipe')
mods.jei.description.add(item('minecraft:gold_ingot') | item('minecraft:iron_block'), 'groovyscript.recipe.fluid_recipe')
mods.jei.description.add(fluid('lava') * 500, ['very', 'hot', 'fluid'])
mods.jei.description.add(item('minecraft:clay'), ['wow', 'this', 'is', 'neat'])

// Ingredient Sidebar:
Expand Down
168 changes: 133 additions & 35 deletions src/main/java/com/cleanroommc/groovyscript/compat/mods/jei/Description.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,60 +1,110 @@
package com.cleanroommc.groovyscript.compat.mods.jei;

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.cleanroommc.groovyscript.api.GroovyBlacklist;
import com.cleanroommc.groovyscript.api.GroovyLog;
import com.cleanroommc.groovyscript.api.IIngredient;
import com.cleanroommc.groovyscript.api.documentation.annotations.Example;
import com.cleanroommc.groovyscript.api.documentation.annotations.MethodDescription;
import com.cleanroommc.groovyscript.api.documentation.annotations.RegistryDescription;
import com.cleanroommc.groovyscript.core.mixin.jei.IngredientInfoRecipeAccessor;
import com.cleanroommc.groovyscript.registry.VirtualizedRegistry;

import mezz.jei.api.IModRegistry;
import mezz.jei.api.IRecipeRegistry;
import mezz.jei.api.ingredients.VanillaTypes;
import mezz.jei.api.ingredients.IIngredientHelper;
import mezz.jei.api.ingredients.IIngredientRegistry;
import mezz.jei.api.recipe.IIngredientType;
import mezz.jei.api.recipe.VanillaRecipeCategoryUid;
import mezz.jei.plugins.jei.info.IngredientInfoRecipeCategory;
import net.minecraft.item.ItemStack;
import org.apache.commons.lang3.tuple.Pair;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import net.minecraftforge.fluids.FluidStack;

@RegistryDescription(category = RegistryDescription.Category.ENTRIES)
public class Description extends VirtualizedRegistry<Pair<List<IIngredient>, List<String>>> {
public class Description extends VirtualizedRegistry<Description.DescriptionEntry> {

public static class DescriptionEntry {
List<Object> ingredients;
String[] descriptionKeys;

@SuppressWarnings("unchecked")
DescriptionEntry(@Nonnull List<?> ingredients, @Nullable List<String> descriptionKeys) {
if (ingredients.isEmpty()) {
throw new IllegalArgumentException("JEI Description Entries must not have an empty list of ingredients, got " + ingredients);
}

// This cast is not exactly correct, but Java/JVM allows it due to type erasure
this.ingredients = (List<Object>) ingredients;

this.descriptionKeys = descriptionKeys == null ? new String[0] : descriptionKeys.toArray(new String[0]);
}

@Nullable
IIngredientType<Object> validateIngredientType(IModRegistry modRegistry) {
Object first = ingredients.get(0);
IIngredientType<Object> ingredientType = modRegistry.getIngredientRegistry().getIngredientType(first);
if (ingredientType == null) {
return null;
}
for (Object o : ingredients) {
if (!ingredientType.equals(modRegistry.getIngredientRegistry().getIngredientType(o))) {
return null;
}
}
return ingredientType;
}
}

private <T> void addIngredientInfo(IModRegistry modRegistry, List<T> ingredients, IIngredientType<T> ingredientType, String[] description) {
// Force Java to pick the correct overload we use
// This is needed because the method has overloads in a way T = Object cannot be substituted
modRegistry.addIngredientInfo(ingredients, ingredientType, description);
}

/**
* Called by {@link JeiPlugin#register}
*/
@GroovyBlacklist
public void applyAdditions(IModRegistry modRegistry) {
for (Pair<List<IIngredient>, List<String>> entry : this.getScriptedRecipes()) {
modRegistry.addIngredientInfo(
entry.getLeft().stream().flatMap(x -> Stream.of(x.getMatchingStacks())).collect(Collectors.toList()),
// Currently, it is only possible to add VanillaTypes.ITEM. It may be desirable to add the ability to do other types.
VanillaTypes.ITEM,
entry.getRight().toArray(new String[0]));
for (DescriptionEntry entry : this.getScriptedRecipes()) {
IIngredientType<Object> ingredientType = entry.validateIngredientType(modRegistry);
if (ingredientType != null) {
addIngredientInfo(modRegistry, entry.ingredients, ingredientType, entry.descriptionKeys);
} else {
GroovyLog.msg("Unable to obtain an ingredient type for items {}", entry.ingredients.toArray())
.error()
.post();
}
}
}

/**
* Called by {@link JeiPlugin#afterRuntimeAvailable()}
*/
@SuppressWarnings("unchecked")
@GroovyBlacklist
public void applyRemovals(IRecipeRegistry recipeRegistry) {
public void applyRemovals(IModRegistry modRegistry, IRecipeRegistry recipeRegistry) {
IIngredientRegistry ingredientRegistry = modRegistry.getIngredientRegistry();
IngredientInfoRecipeCategory category = (IngredientInfoRecipeCategory) recipeRegistry.getRecipeCategory(VanillaRecipeCategoryUid.INFORMATION);
if (category != null) {
recipeRegistry.getRecipeWrappers(category).forEach(wrapper -> {
IngredientInfoRecipeAccessor<?> accessor = (IngredientInfoRecipeAccessor<?>) wrapper;

// Currently, it is only possible to remove VanillaTypes.ITEM. It may be desirable to add the ability to do other types.
if (!VanillaTypes.ITEM.equals(accessor.getIngredientType())) return;

for (Pair<List<IIngredient>, List<String>> entry : this.getBackupRecipes()) {
if (entry.getKey()
for (DescriptionEntry entry : this.getBackupRecipes()) {
IIngredientType<Object> ingredientType = entry.validateIngredientType(modRegistry);
IIngredientHelper<Object> helper = ingredientRegistry.getIngredientHelper(ingredientType);
if (ingredientType == null || !ingredientType.equals(accessor.getIngredientType())) continue;
if (entry.ingredients
.stream()
.anyMatch(x -> accessor.getIngredients().stream().anyMatch(a -> a instanceof ItemStack itemStack && x.test(itemStack)))) {
.anyMatch(x -> accessor.getIngredients().stream().anyMatch(a -> helper.getUniqueId(a).equals(helper.getUniqueId(x))))) {
// the API seems to be broken hence the cast
entry.descriptionKeys = ((List<String>)wrapper.getDescription()).toArray(new String[0]);
recipeRegistry.hideRecipe(wrapper, VanillaRecipeCategoryUid.INFORMATION);
}
}
Expand All @@ -69,32 +119,80 @@ public void onReload() {
}

@MethodDescription(type = MethodDescription.Type.ADDITION)
public void add(List<IIngredient> target, List<String> description) {
addScripted(Pair.of(target, description));
public void add(IIngredient[] target, String... description) {
Copy link
Copy Markdown
Collaborator

@WaitingIdly WaitingIdly Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe do Object[] target + get the IIngredientRegistry#getIngredientType later on + check that everything has the same ingredient type. wouldnt use IIngredient or FluidStack anymore

Copy link
Copy Markdown
Contributor Author

@Wizzerinus Wizzerinus Apr 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, we could do that I guess, that would be much better in terms of future flexibility too

Copy link
Copy Markdown
Member

@brachy84 brachy84 Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this changed to array? Lists are much nicer in groovy.

addScripted(new DescriptionEntry(
Stream.of(target).flatMap(x -> Stream.of(x.getMatchingStacks())).collect(Collectors.toList()),
Arrays.asList(description)));
}

@MethodDescription(type = MethodDescription.Type.ADDITION)
public void add(List<IIngredient> target, String... description) {
addScripted(Pair.of(target, Arrays.asList(description)));
public void add(IIngredient[] target, List<String> description) {
Copy link
Copy Markdown
Member

@brachy84 brachy84 Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This too

Copy link
Copy Markdown
Contributor Author

@Wizzerinus Wizzerinus Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because then we cannot overload based on the input type, as all lists cast down to List<?> on the JVM, and we need to apply different code depending on FluidStack, an IIngredient that is not FluidStack, or another type (the latter is currently not supported in JEI so idk an example for that). We could disambiguate manually though. Idk, these group methods are very uncommon I believe (since for IIngredient you can just use an OrIngredient), so it's hard to tell whether the manual overloading will be worth in the long run.

add(target, description.toArray(new String[0]));
}

@MethodDescription(type = MethodDescription.Type.ADDITION, example = @Example("item('minecraft:clay'), ['wow', 'this', 'is', 'neat']"))
public void add(IIngredient target, List<String> description) {
addScripted(Pair.of(Collections.singletonList(target), description));
add(new IIngredient[]{target}, description);
}

@MethodDescription(type = MethodDescription.Type.ADDITION, example = @Example("item('minecraft:gold_ingot'), 'groovyscript.recipe.fluid_recipe'"))
@MethodDescription(type = MethodDescription.Type.ADDITION, example = @Example("item('minecraft:gold_ingot') | item('minecraft:iron_block'), 'groovyscript.recipe.fluid_recipe'"))
public void add(IIngredient target, String... description) {
addScripted(Pair.of(Collections.singletonList(target), Arrays.asList(description)));
add(new IIngredient[]{target}, description);
}

@MethodDescription(type = MethodDescription.Type.ADDITION)
public void add(Object[] target, String... description) {
Copy link
Copy Markdown
Member

@brachy84 brachy84 Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

List > array

addScripted(new DescriptionEntry(
Arrays.asList(target),
Arrays.asList(description)));
}

@MethodDescription(type = MethodDescription.Type.ADDITION)
public void add(Object[] target, List<String> description) {
Copy link
Copy Markdown
Member

@brachy84 brachy84 Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

List > array

Copy link
Copy Markdown
Contributor Author

@Wizzerinus Wizzerinus Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not possible due to type erasure

add(target, description.toArray(new String[0]));
}

@MethodDescription(type = MethodDescription.Type.ADDITION)
public void add(Object target, List<String> description) {
add(new Object[]{target}, description);
}

@MethodDescription(type = MethodDescription.Type.ADDITION)
public void add(Object target, String... description) {
add(new Object[]{target}, description);
}

// This overload set is the same as Object one. It exists because FluidStack implements IIngredient, but does not have any matching stacks,
// which causes a JEI startup crash when trying to add that description
@MethodDescription(type = MethodDescription.Type.ADDITION)
public void add(FluidStack[] target, String... description) {
Copy link
Copy Markdown
Member

@brachy84 brachy84 Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

List > array

addScripted(new DescriptionEntry(
Arrays.asList(target),
Arrays.asList(description)));
}

@MethodDescription(type = MethodDescription.Type.ADDITION)
public void add(FluidStack[] target, List<String> description) {
Copy link
Copy Markdown
Member

@brachy84 brachy84 Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

List > array

add(target, description.toArray(new String[0]));
}

@MethodDescription(type = MethodDescription.Type.ADDITION, example = @Example("fluid('lava') * 500, ['very', 'hot', 'fluid']"))
public void add(FluidStack target, List<String> description) {
add(new FluidStack[]{target}, description);
}

@MethodDescription(type = MethodDescription.Type.ADDITION, example = @Example("fluid('water') * 1000, 'groovyscript.recipe.fluid_recipe'"))
public void add(FluidStack target, String... description) {
add(new FluidStack[]{target}, description);
}

@MethodDescription(example = @Example(value = "item('thaumcraft:triple_meat_treat')", commented = true))
public void remove(List<IIngredient> target) {
addBackup(Pair.of(target, null));
public void remove(IIngredient target) {
addBackup(new DescriptionEntry(Arrays.asList(target.getMatchingStacks()), null));
}

@MethodDescription
public void remove(IIngredient... target) {
addBackup(Pair.of(Arrays.asList(target), null));
@MethodDescription(example = @Example(value = "fluid('water')", commented = true))
public void remove(Object target) {
addBackup(new DescriptionEntry(Arrays.asList(target), null));
}
}
17 changes: 12 additions & 5 deletions src/main/java/com/cleanroommc/groovyscript/compat/mods/jei/JeiPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
package com.cleanroommc.groovyscript.compat.mods.jei;

import java.util.Comparator;

import org.jetbrains.annotations.NotNull;

import com.cleanroommc.groovyscript.api.GroovyBlacklist;
import com.cleanroommc.groovyscript.api.GroovyLog;
import com.cleanroommc.groovyscript.command.GSCommand;
Expand All @@ -8,8 +12,14 @@
import com.cleanroommc.groovyscript.compat.mods.ModSupport;
import com.cleanroommc.groovyscript.compat.vanilla.ShapedCraftingRecipe;
import com.cleanroommc.groovyscript.compat.vanilla.ShapelessCraftingRecipe;

import mezz.jei.Internal;
import mezz.jei.api.*;
import mezz.jei.api.IJeiHelpers;
import mezz.jei.api.IJeiRuntime;
import mezz.jei.api.IModPlugin;
import mezz.jei.api.IModRegistry;
import mezz.jei.api.IRecipeRegistry;
import mezz.jei.api.JEIPlugin;
import mezz.jei.api.ingredients.IIngredientHelper;
import mezz.jei.api.ingredients.IIngredientRegistry;
import mezz.jei.api.ingredients.IIngredientRenderer;
Expand All @@ -22,9 +32,6 @@
import net.minecraft.item.ItemStack;
import net.minecraft.util.text.TextComponentString;
import net.minecraftforge.fluids.FluidStack;
import org.jetbrains.annotations.NotNull;

import java.util.Comparator;

@SuppressWarnings("AssignmentToStaticFieldFromInstanceMethod")
@GroovyBlacklist
Expand All @@ -47,7 +54,7 @@ public static void afterRegister() {
public static void afterRuntimeAvailable() {
ModSupport.JEI.get().ingredient.applyChanges(modRegistry.getIngredientRegistry());
ModSupport.JEI.get().category.applyChanges(jeiRuntime.getRecipeRegistry());
ModSupport.JEI.get().description.applyRemovals(jeiRuntime.getRecipeRegistry());
ModSupport.JEI.get().description.applyRemovals(modRegistry, jeiRuntime.getRecipeRegistry());
}

/**
Expand Down