chore: update REI integration and updated recipe viewer compatiability to match the current Circuit Fabricator/Compressor GUIs (#408)

* chore: updated recipe viewer compatiability to match the current compressor and circuit fabricator GUIs

* chore: set the circuit fabricator/compressor recipes to special to prevent the unknown recipe category messages

* chore: no longer use deprecated REI methods

* chore: add RecipeBookTypes for Circuit Fabricator and Compressor to be used when extending RecipeBookMenu for #405

Author: Roelymole

src/main/java/dev/galacticraft/mod/Constant.java

@@ -558,8 +558,40 @@ interface ScreenTexture {
         ResourceLocation DEFAULT_SOLAR_PANELS = id("textures/solar_panel/default_solar_panels.png");
         ResourceLocation DEFAULT_LIGHT_SOURCES = id("textures/solar_panel/default_light_sources.png");
         ResourceLocation MOON_LIGHT_SOURCES = id("textures/solar_panel/moon_light_sources.png");
+    }
 
+    interface RecipeViewer {
         ResourceLocation RECIPE_VIEWER_DISPLAY_TEXTURE = id("textures/gui/rei_display.png");
+
+        int CIRCUIT_FABRICATOR_U = 0;
+        int CIRCUIT_FABRICATOR_V = 0;
+        int CIRCUIT_FABRICATOR_WIDTH = 139;
+        int CIRCUIT_FABRICATOR_HEIGHT = 73;
+
+        int DIAMOND_X = 1;
+        int DIAMOND_Y = 1;
+        int SILICON_X_1 = 32;
+        int SILICON_Y_1 = 31;
+        int SILICON_X_2 = 32;
+        int SILICON_Y_2 = 49;
+        int REDSTONE_X = 77;
+        int REDSTONE_Y = 56;
+        int INGREDIENT_X = 104;
+        int INGREDIENT_Y = 1;
+        int WAFER_X = 122;
+        int WAFER_Y = 56;
+
+        int COMPRESSOR_U = 0;
+        int COMPRESSOR_V = 74;
+        int COMPRESSOR_WIDTH = 148;
+        int COMPRESSOR_HEIGHT = 54;
+
+        int FIRE_X = 67;
+        int FIRE_Y = 9;
+        int FUEL_X = 67;
+        int FUEL_Y = 31;
+        int COMPRESSED_X = 127;
+        int COMPRESSED_Y = 20;
     }
 
     interface SlotSprite {

src/main/java/dev/galacticraft/mod/compat/jei/category/JEICompressingCategory.java

@@ -22,7 +22,6 @@
 
 package dev.galacticraft.mod.compat.jei.category;
 
-import dev.galacticraft.mod.Constant;
 import dev.galacticraft.mod.compat.jei.GCJEIRecipeTypes;
 import dev.galacticraft.mod.content.GCBlocks;
 import dev.galacticraft.mod.recipe.CompressingRecipe;
@@ -37,12 +36,14 @@
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.item.ItemStack;
 
+import static dev.galacticraft.mod.Constant.RecipeViewer.*;
+
 public class JEICompressingCategory implements IRecipeCategory<CompressingRecipe> {
     private final IDrawable icon, background;
 
     public JEICompressingCategory(IGuiHelper helper) {
         this.icon = helper.createDrawableItemStack(new ItemStack(GCBlocks.COMPRESSOR));
-        this.background = helper.createDrawable(Constant.ScreenTexture.RECIPE_VIEWER_DISPLAY_TEXTURE, 0, 83, 137, 157);
+        this.background = helper.createDrawable(RECIPE_VIEWER_DISPLAY_TEXTURE, COMPRESSOR_U, COMPRESSOR_V, COMPRESSOR_HEIGHT, COMPRESSOR_WIDTH);
     }
 
     @Override
@@ -67,7 +68,7 @@ public IDrawable getIcon() {
 
     @Override
     public void setRecipe(IRecipeLayoutBuilder builder, CompressingRecipe recipe, IFocusGroup focuses) {
-        builder.addSlot(RecipeIngredientRole.OUTPUT, 120, 21)
+        builder.addSlot(RecipeIngredientRole.OUTPUT, COMPRESSED_X, COMPRESSED_Y)
                 .addItemStack(recipe.getResultItem(null)); //fixme
     }
 }

src/main/java/dev/galacticraft/mod/compat/jei/category/JEIFabricationCategory.java

@@ -22,7 +22,6 @@
 
 package dev.galacticraft.mod.compat.jei.category;
 
-import dev.galacticraft.mod.Constant;
 import dev.galacticraft.mod.compat.jei.GCJEIRecipeTypes;
 import dev.galacticraft.mod.content.GCBlocks;
 import dev.galacticraft.mod.content.item.GCItems;
@@ -39,13 +38,15 @@
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.Items;
 
+import static dev.galacticraft.mod.Constant.RecipeViewer.*;
+
 public class JEIFabricationCategory implements IRecipeCategory<FabricationRecipe> {
 
     private final IDrawable icon, background;
 
     public JEIFabricationCategory(IGuiHelper helper) {
         this.icon = helper.createDrawableItemStack(new ItemStack(GCBlocks.CIRCUIT_FABRICATOR));
-        this.background = helper.createDrawable(Constant.ScreenTexture.RECIPE_VIEWER_DISPLAY_TEXTURE, 0, 0, 162, 82);
+        this.background = helper.createDrawable(RECIPE_VIEWER_DISPLAY_TEXTURE, CIRCUIT_FABRICATOR_U, CIRCUIT_FABRICATOR_V, CIRCUIT_FABRICATOR_WIDTH, CIRCUIT_FABRICATOR_HEIGHT);
     }
 
     @Override
@@ -70,18 +71,18 @@ public IDrawable getIcon() {
 
     @Override
     public void setRecipe(IRecipeLayoutBuilder builder, FabricationRecipe recipe, IFocusGroup focuses) {
-        builder.addSlot(RecipeIngredientRole.INPUT, 1, 1)
+        builder.addSlot(RecipeIngredientRole.INPUT, DIAMOND_X, DIAMOND_Y)
                 .addItemStack(Items.DIAMOND.getDefaultInstance());
-        builder.addSlot(RecipeIngredientRole.INPUT, 55, 47)
+        builder.addSlot(RecipeIngredientRole.INPUT, SILICON_X_1, SILICON_Y_1)
                 .addItemStack(GCItems.SILICON.getDefaultInstance());
-        builder.addSlot(RecipeIngredientRole.INPUT, 55, 65)
+        builder.addSlot(RecipeIngredientRole.INPUT, SILICON_X_2, SILICON_Y_2)
                 .addItemStack(GCItems.SILICON.getDefaultInstance());
-        builder.addSlot(RecipeIngredientRole.CATALYST, 109, 47)
+        builder.addSlot(RecipeIngredientRole.CATALYST, REDSTONE_X, REDSTONE_Y)
                 .addItemStack(Items.REDSTONE.getDefaultInstance());
-        builder.addSlot(RecipeIngredientRole.CATALYST, 127, 1)
+        builder.addSlot(RecipeIngredientRole.CATALYST, INGREDIENT_X, INGREDIENT_Y)
                 .addIngredients(recipe.getIngredients().get(0));
 
-        builder.addSlot(RecipeIngredientRole.OUTPUT, 145, 65)
+        builder.addSlot(RecipeIngredientRole.OUTPUT, WAFER_X, WAFER_Y)
                 .addItemStack(recipe.getResultItem(null)); //fixme
     }
 }

src/main/java/dev/galacticraft/mod/compat/rei/client/GalacticraftREIClientPlugin.java

@@ -22,6 +22,7 @@
 
 package dev.galacticraft.mod.compat.rei.client;
 
+import dev.galacticraft.machinelib.api.menu.RecipeMachineMenu;
 import dev.galacticraft.machinelib.client.api.screen.MachineScreen;
 import dev.galacticraft.machinelib.impl.Constant.TextureCoordinate;
 import dev.galacticraft.mod.compat.rei.client.category.DefaultCompressingCategory;
@@ -43,6 +44,7 @@
 import me.shedaniel.rei.api.client.registry.entry.EntryRegistry;
 import me.shedaniel.rei.api.client.registry.screen.ExclusionZones;
 import me.shedaniel.rei.api.client.registry.transfer.TransferHandlerRegistry;
+import me.shedaniel.rei.api.client.registry.transfer.simple.SimpleTransferHandler;
 import me.shedaniel.rei.api.common.util.EntryStacks;
 import me.shedaniel.rei.plugin.common.BuiltinPlugin;
 import net.minecraft.world.level.ItemLike;
@@ -61,9 +63,6 @@ public void registerCategories(CategoryRegistry registry) {
         registry.addWorkstations(BuiltinPlugin.BLASTING, EntryStacks.of(GCBlocks.ELECTRIC_ARC_FURNACE));
         registry.addWorkstations(BuiltinPlugin.SMELTING, EntryStacks.of(GCBlocks.ELECTRIC_FURNACE));
         registry.addWorkstations(BuiltinPlugin.FUEL, EntryStacks.of(GCBlocks.COMPRESSOR));
-
-        registry.setPlusButtonArea(GalacticraftREIServerPlugin.CIRCUIT_FABRICATION, bounds -> new Rectangle(bounds.getMinX() + 8, bounds.getMaxY() - 16, 10, 10));
-        registry.setPlusButtonArea(GalacticraftREIServerPlugin.COMPRESSING, bounds -> new Rectangle(bounds.getMaxX() - 16, bounds.getMaxY() - 16, 10, 10));
     }
 
     @Override
@@ -95,5 +94,9 @@ public void registerExclusionZones(ExclusionZones zones) {
 
     @Override
     public void registerTransferHandlers(TransferHandlerRegistry registry) {
+        registry.register(SimpleTransferHandler.create(RecipeMachineMenu.class, GalacticraftREIServerPlugin.COMPRESSING,
+                new SimpleTransferHandler.IntRange(1, 10)));
+        registry.register(SimpleTransferHandler.create(RecipeMachineMenu.class, GalacticraftREIServerPlugin.CIRCUIT_FABRICATION,
+                new SimpleTransferHandler.IntRange(1, 6)));
     }
 }

src/main/java/dev/galacticraft/mod/compat/rei/client/category/BaseWidget.java

@@ -23,7 +23,6 @@
 package dev.galacticraft.mod.compat.rei.client.category;
 
 import com.mojang.blaze3d.platform.Lighting;
-import dev.galacticraft.mod.Constant;
 import me.shedaniel.math.Point;
 import me.shedaniel.rei.api.client.gui.widgets.Widget;
 import net.minecraft.client.gui.GuiGraphics;
@@ -34,6 +33,8 @@
 import java.util.Collections;
 import java.util.List;
 
+import static dev.galacticraft.mod.Constant.RecipeViewer.*;
+
 public class BaseWidget extends Widget {
 
     private final Point startPoint;
@@ -45,12 +46,12 @@ public class BaseWidget extends Widget {
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {
         Lighting.setupForFlatItems();
-        graphics.blit(Constant.ScreenTexture.RECIPE_VIEWER_DISPLAY_TEXTURE, this.startPoint.x, this.startPoint.y, 0, 83, 137, 157);
+        graphics.blit(RECIPE_VIEWER_DISPLAY_TEXTURE, this.startPoint.x, this.startPoint.y, COMPRESSOR_U, COMPRESSOR_V, COMPRESSOR_WIDTH, COMPRESSOR_HEIGHT);
 
         int height = Mth.ceil((double) (System.currentTimeMillis() / 250L) % 14.0D);
-        graphics.blit(Constant.ScreenTexture.RECIPE_VIEWER_DISPLAY_TEXTURE, this.startPoint.x + 2, this.startPoint.y + 21 + (14 - height), 82, 77 + (14 - height), 14, height);
+        graphics.blit(RECIPE_VIEWER_DISPLAY_TEXTURE, this.startPoint.x + 2, this.startPoint.y + 21 + (14 - height), 82, 77 + (14 - height), 14, height);
         int width = Mth.ceil((double) (System.currentTimeMillis() / 250L) % 24.0D);
-        graphics.blit(Constant.ScreenTexture.RECIPE_VIEWER_DISPLAY_TEXTURE, this.startPoint.x + 24, this.startPoint.y + 18, 82, 91, width, 17);
+        graphics.blit(RECIPE_VIEWER_DISPLAY_TEXTURE, this.startPoint.x + 24, this.startPoint.y + 18, 82, 91, width, 17);
     }
 
     @Override

src/main/java/dev/galacticraft/mod/compat/rei/client/category/DefaultCompressingCategory.java

@@ -44,10 +44,13 @@
 import net.minecraft.world.level.block.entity.AbstractFurnaceBlockEntity;
 import org.jetbrains.annotations.NotNull;
 
+import java.text.DecimalFormat;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.stream.Collectors;
 
+import static dev.galacticraft.mod.Constant.RecipeViewer.*;
+
 @Environment(EnvType.CLIENT)
 public class DefaultCompressingCategory implements DisplayCategory<DefaultCompressingDisplay> {
 
@@ -67,13 +70,18 @@ public Component getTitle() {
     }
 
     public @NotNull List<Widget> setupDisplay(DefaultCompressingDisplay recipeDisplay, Rectangle bounds) {
-        final Point startPoint = new Point(bounds.getCenterX() - 68, bounds.getCenterY() - 37);
+        final Point startPoint = new Point(bounds.getCenterX() - COMPRESSOR_WIDTH / 2, bounds.getCenterY() - COMPRESSOR_HEIGHT / 2);
         List<Widget> widgets = new ArrayList<>();
         widgets.add(Widgets.createRecipeBase(bounds));
         widgets.add(new BaseWidget(startPoint));
         List<EntryIngredient> input = recipeDisplay.getInputEntries();
         List<Slot> slots = Lists.newArrayList();
 
+        DecimalFormat df = new DecimalFormat("###.##");
+        double processingTime = recipeDisplay.getProcessingTime();
+        widgets.add(Widgets.createLabel(new Point(bounds.x + bounds.width - 5, bounds.y + 5),
+                Component.translatable("category.rei.campfire.time", df.format(processingTime / 20.0D))).noShadow().rightAligned().color(0xFF404040, 0xFFBBBBBB));
+
         // 3x3 grid
         // Output
         int i;
@@ -89,9 +97,10 @@ public Component getTitle() {
         }
 
         widgets.addAll(slots);
-        widgets.add(Widgets.createSlot(new Point(startPoint.x + 120, startPoint.y + (18) + 3)).markOutput().entries(recipeDisplay.getOutputEntries().get(0)));
+        widgets.add(Widgets.createSlot(new Point(startPoint.x + COMPRESSED_X, startPoint.y + COMPRESSED_Y)).disableBackground().markOutput().entries(recipeDisplay.getOutputEntries().get(0)));
 
-        widgets.add(Widgets.createSlot(new Point(startPoint.x + (2 * 18) + 1, startPoint.y + (18 * 3) + 4)).markInput().entries(AbstractFurnaceBlockEntity.getFuel().keySet().stream().map(EntryStacks::of).collect(Collectors.toList())));
+        widgets.add(Widgets.createSlot(new Point(startPoint.x + FUEL_X, startPoint.y + FUEL_Y)).markInput().entries(AbstractFurnaceBlockEntity.getFuel().keySet().stream().map(EntryStacks::of).collect(Collectors.toList())));
+        widgets.add(Widgets.createBurningFire(new Point(startPoint.x + FIRE_X, startPoint.y + FIRE_Y)).animationDurationMS(10000));
         return widgets;
     }
 
@@ -134,12 +143,12 @@ public int getMaximumDisplaysPerPage() {
 
     @Override
     public int getDisplayHeight() {
-        return 84;
+        return COMPRESSOR_HEIGHT + 8;
     }
 
     @Override
     public int getDisplayWidth(DefaultCompressingDisplay display) {
-        return 146;
+        return COMPRESSOR_WIDTH + 8;
     }
 
 }

src/main/java/dev/galacticraft/mod/compat/rei/client/category/DefaultFabricationCategory.java

@@ -22,7 +22,6 @@
 
 package dev.galacticraft.mod.compat.rei.client.category;
 
-import dev.galacticraft.mod.Constant;
 import dev.galacticraft.mod.compat.rei.common.GalacticraftREIServerPlugin;
 import dev.galacticraft.mod.compat.rei.common.display.DefaultFabricationDisplay;
 import dev.galacticraft.mod.content.GCBlocks;
@@ -40,9 +39,12 @@
 import net.minecraft.network.chat.Component;
 import org.jetbrains.annotations.NotNull;
 
+import java.text.DecimalFormat;
 import java.util.LinkedList;
 import java.util.List;
 
+import static dev.galacticraft.mod.Constant.RecipeViewer.*;
+
 @Environment(EnvType.CLIENT)
 public class DefaultFabricationCategory implements DisplayCategory<DefaultFabricationDisplay> {
     @Override
@@ -62,36 +64,41 @@ public Component getTitle() {
 
     @Override
     public @NotNull List<Widget> setupDisplay(DefaultFabricationDisplay recipeDisplay, Rectangle bounds) {
-        final Point startPoint = new Point(bounds.getCenterX() - 81, bounds.getCenterY() - 41);
+        final Point startPoint = new Point(bounds.getCenterX() - CIRCUIT_FABRICATOR_WIDTH / 2, bounds.getCenterY() - CIRCUIT_FABRICATOR_HEIGHT / 2);
 
         List<Widget> widgets = new LinkedList<>();
         widgets.add(Widgets.createRecipeBase(bounds));
-        widgets.add(Widgets.createTexturedWidget(Constant.ScreenTexture.RECIPE_VIEWER_DISPLAY_TEXTURE, new Rectangle(startPoint.x, startPoint.y, 162, 82)));
+        widgets.add(Widgets.createTexturedWidget(RECIPE_VIEWER_DISPLAY_TEXTURE, new Rectangle(startPoint.x, startPoint.y, CIRCUIT_FABRICATOR_WIDTH, CIRCUIT_FABRICATOR_HEIGHT)));
+
+        DecimalFormat df = new DecimalFormat("###.##");
+        double processingTime = recipeDisplay.getProcessingTime();
+        widgets.add(Widgets.createLabel(new Point(bounds.getCenterX(), bounds.y + 5),
+                Component.translatable("category.rei.campfire.time", df.format(processingTime / 20.0D))).noShadow().color(0xFF404040, 0xFFBBBBBB));
 
         // Diamond ingredients
         // Silicon
         // Silicon
         // Redstone
         // User ingredients
         // Output
-        widgets.add(Widgets.createSlot(new Point(startPoint.x + 1, startPoint.y + 1)).entries(recipeDisplay.getInputEntries().get(0)));
-        widgets.add(Widgets.createSlot(new Point(startPoint.x + 55, startPoint.y + 47)).entries(recipeDisplay.getInputEntries().get(1)));
-        widgets.add(Widgets.createSlot(new Point(startPoint.x + 55, startPoint.y + 65)).entries(recipeDisplay.getInputEntries().get(2)));
-        widgets.add(Widgets.createSlot(new Point(startPoint.x + 109, startPoint.y + 47)).entries(recipeDisplay.getInputEntries().get(3)));
-        widgets.add(Widgets.createSlot(new Point(startPoint.x + 127, startPoint.y + 1)).markOutput().entries(recipeDisplay.getInputEntries().get(4)));
+        widgets.add(Widgets.createSlot(new Point(startPoint.x + DIAMOND_X, startPoint.y + DIAMOND_Y)).entries(recipeDisplay.getInputEntries().get(0)));
+        widgets.add(Widgets.createSlot(new Point(startPoint.x + SILICON_X_1, startPoint.y + SILICON_Y_1)).entries(recipeDisplay.getInputEntries().get(1)));
+        widgets.add(Widgets.createSlot(new Point(startPoint.x + SILICON_X_2, startPoint.y + SILICON_Y_2)).entries(recipeDisplay.getInputEntries().get(2)));
+        widgets.add(Widgets.createSlot(new Point(startPoint.x + REDSTONE_X, startPoint.y + REDSTONE_Y)).entries(recipeDisplay.getInputEntries().get(3)));
+        widgets.add(Widgets.createSlot(new Point(startPoint.x + INGREDIENT_X, startPoint.y + INGREDIENT_Y)).entries(recipeDisplay.getInputEntries().get(4)));
 
-        widgets.add(Widgets.createSlot(new Point(startPoint.x + 145, startPoint.y + 65)).markOutput().entries(recipeDisplay.getOutputEntries().get(0)));
+        widgets.add(Widgets.createSlot(new Point(startPoint.x + WAFER_X, startPoint.y + WAFER_Y)).markOutput().entries(recipeDisplay.getOutputEntries().get(0)));
         return widgets;
     }
 
     @Override
     public int getDisplayHeight() {
-        return 90;
+        return CIRCUIT_FABRICATOR_HEIGHT + 8;
     }
 
     @Override
     public int getDisplayWidth(DefaultFabricationDisplay display) {
-        return 170;
+        return CIRCUIT_FABRICATOR_WIDTH + 8;
     }
 
     @Override

src/main/java/dev/galacticraft/mod/compat/rei/common/GalacticraftREIServerPlugin.java

@@ -22,31 +22,19 @@
 
 package dev.galacticraft.mod.compat.rei.common;
 
-import dev.galacticraft.machinelib.api.menu.RecipeMachineMenu;
 import dev.galacticraft.mod.Constant;
 import dev.galacticraft.mod.compat.rei.common.display.DefaultCompressingDisplay;
 import dev.galacticraft.mod.compat.rei.common.display.DefaultFabricationDisplay;
-import dev.galacticraft.mod.compat.rei.common.transfer.info.FabricationMenuInfo;
-import dev.galacticraft.mod.compat.rei.common.transfer.info.SimpleMachineMenuInfo;
-import dev.galacticraft.mod.content.block.entity.machine.CompressorBlockEntity;
 import me.shedaniel.rei.api.common.category.CategoryIdentifier;
 import me.shedaniel.rei.api.common.display.DisplaySerializerRegistry;
 import me.shedaniel.rei.api.common.display.basic.BasicDisplay;
 import me.shedaniel.rei.api.common.plugins.REIServerPlugin;
-import me.shedaniel.rei.api.common.transfer.info.MenuInfoRegistry;
-import me.shedaniel.rei.api.common.transfer.info.simple.SimpleMenuInfoProvider;
 
 public class GalacticraftREIServerPlugin implements REIServerPlugin {
     public static final CategoryIdentifier<DefaultFabricationDisplay> CIRCUIT_FABRICATION = CategoryIdentifier.of(Constant.MOD_ID, "plugins/circuit_fabricator");
     public static final CategoryIdentifier<DefaultCompressingDisplay> COMPRESSING = CategoryIdentifier.of(Constant.MOD_ID, "plugins/compressing");
 //    public static final CategoryIdentifier<DefaultCompressingDisplay> COAL_GENERATOR_FUEL = CategoryIdentifier.of(Constant.MOD_ID, "plugins/coal_generator_fuel");
 
-    @Override
-    public void registerMenuInfo(MenuInfoRegistry registry) {
-        registry.register(COMPRESSING, RecipeMachineMenu.class, SimpleMenuInfoProvider.of(d -> new SimpleMachineMenuInfo<>(3, 3, CompressorBlockEntity.OUTPUT_SLOT, d)));
-        registry.register(CIRCUIT_FABRICATION, RecipeMachineMenu.class, SimpleMenuInfoProvider.of(FabricationMenuInfo::new));
-    }
-
     @Override
     public void registerDisplaySerializer(DisplaySerializerRegistry registry) {
         registry.register(CIRCUIT_FABRICATION, BasicDisplay.Serializer.ofSimple(DefaultFabricationDisplay::createRaw));

src/main/java/dev/galacticraft/mod/compat/rei/common/display/DefaultCompressingDisplay.java

@@ -49,6 +49,10 @@ default int getHeight() {
         return 3;
     }
 
+    default int getProcessingTime() {
+        return 10;
+    }
+
     enum Serializer implements DisplaySerializer<DefaultCompressingDisplay> {
         INSTANCE;