Switch to native Forge config system

- Switched from MidnightLib to the native Forge config system, as the library does not support future versions of LexForge
- Lowered defaultRequire to 0 to avoid crashes even when mixins fail to apply
- Fixed Forge refmap warning
- Updated GitHub workflow

Author: Tschipcraft

.github/workflows/build.yml

@@ -1,34 +1,21 @@
-# Automatically build the project and run any configured tests for every push
-# and submitted pull request. This can help catch issues that only occur on
-# certain platforms or Java versions, and provides a first line of defence
-# against bad commits.
-
 name: build
 on: [pull_request, push]
 
 jobs:
   build:
     name: Build
-    strategy:
-      matrix:
-        # Use these Java versions
-        java: [
-          17,    # Current Java LTS & minimum supported by Minecraft
-        ]
-        # and run on both Linux and Windows
-        os: [ubuntu-latest, windows-latest]
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
           show-progress: false
       - name: Validate gradle wrapper
         uses: gradle/wrapper-validation-action@v2
-      - name: Setup jdk ${{ matrix.java }}
+      - name: Setup JDK 21
         uses: actions/setup-java@v4
         with:
-          java-version: ${{ matrix.java }}
+          java-version: 21
           distribution: temurin
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
@@ -41,14 +28,12 @@ jobs:
       - name: Build
         run: ./gradlew build
       - name: Capture fabric build artifact
-        if: ${{ runner.os == 'Linux' && matrix.java == '17' }} # Only upload artifacts built from latest java on one OS
         uses: actions/upload-artifact@v4
         with:
-          name: "Make Bubbles Pop Fabric 1.21.2-1.21.4 (Unzip Me)"
+          name: "Make Bubbles Pop Fabric for Minecraft 1.21.2-1.21.4 (Unzip Me)"
           path: fabric/build/libs/make_bubbles_pop-*.jar
       - name: Capture forge build artifact
-        if: ${{ runner.os == 'Linux' && matrix.java == '17' }} # Only upload artifacts built from latest java on one OS
         uses: actions/upload-artifact@v4
         with:
-          name: "Make Bubbles Pop Forge 1.21.2-1.21.4 (Unzip Me)"
+          name: "Make Bubbles Pop Forge for Minecraft 1.21.2-1.21.4 (Unzip Me)"
           path: forge/build/libs/make_bubbles_pop-*.jar

README.md

@@ -28,6 +28,8 @@ Fixes [MC-132067](https://bugs.mojang.com/browse/MC-132067).
 
 Download the latest release from [here](https://github.com/Tschipcraft/fabric_make_bubbles_pop_mod/releases/latest) and put the .jar file into the `mods` folder in your Minecraft directory.
 
+To configure Make Bubbles Pop, install [MidnightLib](https://modrinth.com/mod/midnightlib) for Fabric or [Configured](https://www.curseforge.com/minecraft/mc-mods/configured) for Forge alongside it.
+
 This mod is also available on Modrinth and CurseForge!
 
 <a href="https://modrinth.com/mod/make_bubbles_pop">

fabric/src/main/resources/fabric.mod.json

@@ -12,8 +12,8 @@
   "depends": {
     "fabricloader": ">=0.14.17",
     "fabric": "*",
-    "minecraft": ">=1.19.4",
-    "java": ">=17"
+    "minecraft": ">=1.21.2",
+    "java": ">=21"
   },
   "id": "make_bubbles_pop",
   "version": "${version}-fabric",
@@ -26,7 +26,7 @@
   ],
   "contact": {
     "homepage": "https://tschipcraft.ddns.net/make_bubbles_pop.html",
-    "sources": "https://github.com/Tschipcraft/make_bubbles_pop",
+    "sources": "https://github.com/Tschipcraft/make_bubbles_pop/tree/1.21.2-1.21.4",
     "issues": "https://github.com/Tschipcraft/make_bubbles_pop/issues"
   },
   "recommends": {

fabric/src/main/resources/make_bubbles_pop.mixins.json

@@ -2,7 +2,7 @@
   "required": true,
   "minVersion": "0.8",
   "package": "net.tschipcraft.make_bubbles_pop.mixin",
-  "compatibilityLevel": "JAVA_17",
+  "compatibilityLevel": "JAVA_21",
   "client": [
     "client.BubblePop",
     "client.BubbleColumnPop",
@@ -14,6 +14,6 @@
     "client.ExplosionEmitterBubble"
   ],
   "injectors": {
-    "defaultRequire": 1
+    "defaultRequire": 0
   }
 }

forge/build.gradle

@@ -253,5 +253,5 @@ sourceSets.each {
 apply plugin: 'org.spongepowered.mixin'
 
 mixin {
-    add sourceSets.main, "${modid}.refmap.json"
+    add sourceSets.main, "${modid}-refmap.json"
 }

forge/src/main/java/net/tschipcraft/make_bubbles_pop/MakeBubblesPop.java

@@ -1,13 +1,11 @@
 package net.tschipcraft.make_bubbles_pop;
 
 import com.mojang.logging.LogUtils;
-import eu.midnightdust.lib.config.MidnightConfig;
-import net.minecraftforge.client.ConfigScreenHandler;
 import net.minecraftforge.common.MinecraftForge;
 import net.minecraftforge.eventbus.api.IEventBus;
 import net.minecraftforge.fml.ModList;
-import net.minecraftforge.fml.ModLoadingContext;
 import net.minecraftforge.fml.common.Mod;
+import net.minecraftforge.fml.config.ModConfig;
 import net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent;
 import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
 import org.slf4j.Logger;
@@ -20,30 +18,24 @@ public class MakeBubblesPop {
     // Directly reference a slf4j logger
     private static final Logger LOGGER = LogUtils.getLogger();
 
-    public static final boolean MIDNIGHTLIB_INSTALLED = ModList.get().isLoaded("midnightlib");
+    // Compatibility flags
+    public static final boolean COMPAT_PARTICLE_TWEAKS = ModList.get().isLoaded("particletweaks");
 
 
-    public MakeBubblesPop() {
-        IEventBus modEventBus = FMLJavaModLoadingContext.get().getModEventBus();
+    public MakeBubblesPop(FMLJavaModLoadingContext context) {
+        IEventBus modEventBus = context.getModEventBus();
 
         // Register the setup method for modloading
         modEventBus.addListener(this::setup);
 
         // Register ourselves for server and other game events we are interested in
         MinecraftForge.EVENT_BUS.register(this);
+
+        // Register config
+        context.registerConfig(ModConfig.Type.CLIENT, MakeBubblesPopConfig.SPEC);
     }
 
     private void setup(final FMLCommonSetupEvent event) {
-        if (MIDNIGHTLIB_INSTALLED) {
-            // Use MidnightLib features
-            LOGGER.info("MidnightLib detected!");
-            MakeBubblesPopConfig.init(MODID, MakeBubblesPopConfig.class);
-            ModLoadingContext.get().registerExtensionPoint(ConfigScreenHandler.ConfigScreenFactory.class, () -> {
-                return new ConfigScreenHandler.ConfigScreenFactory((client, parent) -> {
-                    return MidnightConfig.getScreen(parent, MODID);
-                });
-            });
-        }
         LOGGER.info("Make Bubbles Pop by Tschipcraft initialized!");
     }
 

forge/src/main/java/net/tschipcraft/make_bubbles_pop/MakeBubblesPopConfig.java

@@ -1,50 +1,101 @@
 package net.tschipcraft.make_bubbles_pop;
 
-import eu.midnightdust.lib.config.MidnightConfig;
-
-public class MakeBubblesPopConfig extends MidnightConfig {
-
-    @Entry
-    public static boolean POP_PARTICLE_ENABLED = true;
-
-    // Show this entry with percentage if possible
-    @Entry(isSlider = true, min = 0F, max = 1F, precision = 100)
-    public static float BUBBLE_POP_VOLUME = 0.1F;
-
-    @Entry
-    public static boolean POPPED_BUBBLES_MAINTAIN_VELOCITY = false;
-
-
-    @Comment(centered = true)
-    public static Comment empty;
-
-    @Comment(centered = true)
-    public static Comment additional_features;
-
-    @Entry
-    public static boolean BUBBLE_PHYSICS_ENABLED = true;
-
-    @Entry(isSlider = true, min = 1D, max = 100D, precision = 2)
-    public static double BUBBLE_LIFETIME_MULTIPLIER = 32D;
-
-    @Entry
-    public static boolean BIOME_COLORS_ENABLED = true;
-
-    // Show this entry with percentage if possible
-    @Entry(isSlider = true, min = 0F, max = 1F, precision = 100)
-    public static float BIOME_COLOR_INTENSITY = 0.65F;
-
-
-    @Entry
-    public static boolean CHEST_BUBBLES_ENABLED = true;
-
-    @Entry
-    public static boolean BARREL_BUBBLES_ENABLED = true;
-
-    @Entry
-    public static boolean CONTAINER_SOUND_ENABLED = true;
-
-    @Entry
-    public static boolean EXPLOSION_BUBBLES_ENABLED = true;
+import net.minecraftforge.common.ForgeConfigSpec;
+import net.minecraftforge.eventbus.api.SubscribeEvent;
+import net.minecraftforge.fml.common.Mod;
+import net.minecraftforge.fml.event.config.ModConfigEvent;
+
+@Mod.EventBusSubscriber(modid = MakeBubblesPop.MODID, bus = Mod.EventBusSubscriber.Bus.MOD)
+public class MakeBubblesPopConfig {
+
+    private static final ForgeConfigSpec.Builder BUILDER = new ForgeConfigSpec.Builder();
+
+    private static final ForgeConfigSpec.BooleanValue POP_PARTICLE_ENABLED_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.POP_PARTICLE_ENABLED")
+            .comment("Default: true")
+            .define("POP_PARTICLE_ENABLED", true);
+
+    private static final ForgeConfigSpec.DoubleValue BUBBLE_POP_VOLUME_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.BUBBLE_POP_VOLUME")
+            .comment("Default: §b10%§f")
+            .defineInRange("BUBBLE_POP_VOLUME", 0.1D, 0D, 1D);
+
+    private static final ForgeConfigSpec.BooleanValue POPPED_BUBBLES_MAINTAIN_VELOCITY_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.POPPED_BUBBLES_MAINTAIN_VELOCITY")
+            .comment("If enabled, popped bubbles will maintain their velocity. Default: false")
+            .define("POPPED_BUBBLES_MAINTAIN_VELOCITY", false);
+
+    private static final ForgeConfigSpec.BooleanValue BUBBLE_PHYSICS_ENABLED_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.BUBBLE_PHYSICS_ENABLED")
+            .comment("If enabled, bubbles will be affected by physics when colliding with blocks or entities. Default: true")
+            .define("BUBBLE_PHYSICS_ENABLED", true);
+
+    private static final ForgeConfigSpec.DoubleValue BUBBLE_LIFETIME_MULTIPLIER_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.BUBBLE_LIFETIME_MULTIPLIER")
+            .comment("The time it takes for a bubble to pop underwater. \nBy default, this is set longer than in vanilla to allow bubbles to reach the water surface. \nDefault: §b32.0§f §7(Vanilla: 8.0)§f")
+            .defineInRange("BUBBLE_LIFETIME_MULTIPLIER", 32D, 1D, 100D);
+
+    private static final ForgeConfigSpec.BooleanValue BIOME_COLORS_ENABLED_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.BIOME_COLORS_ENABLED")
+            .comment("If enabled, bubbles will have a color based on the biome they are in. Default: true")
+            .define("BIOME_COLORS_ENABLED", true);
+
+    private static final ForgeConfigSpec.DoubleValue BIOME_COLOR_INTENSITY_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.BIOME_COLOR_INTENSITY")
+            .comment("Default: §b65%§f")
+            .defineInRange("BIOME_COLOR_INTENSITY", 0.65D, 0D, 1D);
+
+    private static final ForgeConfigSpec.BooleanValue CHEST_BUBBLES_ENABLED_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.CHEST_BUBBLES_ENABLED")
+            .comment("If enabled, bubbles will appear when opening chests underwater. Default: true")
+            .define("CHEST_BUBBLES_ENABLED", true);
+
+    private static final ForgeConfigSpec.BooleanValue BARREL_BUBBLES_ENABLED_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.BARREL_BUBBLES_ENABLED")
+            .comment("If enabled, bubbles will appear when opening barrels underwater. Default: true")
+            .define("BARREL_BUBBLES_ENABLED", true);
+
+    private static final ForgeConfigSpec.BooleanValue CONTAINER_SOUND_ENABLED_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.CONTAINER_SOUND_ENABLED")
+            .comment("If enabled, a sound will play when opening chests or barrels underwater. Default: true")
+            .define("CONTAINER_SOUND_ENABLED", true);
+
+    private static final ForgeConfigSpec.BooleanValue EXPLOSION_BUBBLES_ENABLED_CONF = BUILDER
+            .translation("make_bubbles_pop.midnightconfig.EXPLOSION_BUBBLES_ENABLED")
+            .comment("If enabled, bubbles will appear when an explosion occurs underwater. Default: true")
+            .define("EXPLOSION_BUBBLES_ENABLED", true);
+
+    public static final ForgeConfigSpec SPEC = BUILDER.build();
+
+
+    // Config values
+    public static boolean POP_PARTICLE_ENABLED;
+    public static float BUBBLE_POP_VOLUME;
+    public static boolean POPPED_BUBBLES_MAINTAIN_VELOCITY;
+
+    public static boolean BUBBLE_PHYSICS_ENABLED;
+    public static double BUBBLE_LIFETIME_MULTIPLIER;
+    public static boolean BIOME_COLORS_ENABLED;
+    public static float BIOME_COLOR_INTENSITY;
+
+    public static boolean CHEST_BUBBLES_ENABLED;
+    public static boolean BARREL_BUBBLES_ENABLED;
+    public static boolean CONTAINER_SOUND_ENABLED;
+    public static boolean EXPLOSION_BUBBLES_ENABLED;
+
+    @SubscribeEvent
+    static void onLoad(final ModConfigEvent event) {
+        POP_PARTICLE_ENABLED = POP_PARTICLE_ENABLED_CONF.get();
+        BUBBLE_POP_VOLUME = BUBBLE_POP_VOLUME_CONF.get().floatValue();
+        POPPED_BUBBLES_MAINTAIN_VELOCITY = POPPED_BUBBLES_MAINTAIN_VELOCITY_CONF.get();
+        BUBBLE_PHYSICS_ENABLED = BUBBLE_PHYSICS_ENABLED_CONF.get();
+        BUBBLE_LIFETIME_MULTIPLIER = BUBBLE_LIFETIME_MULTIPLIER_CONF.get();
+        BIOME_COLORS_ENABLED = BIOME_COLORS_ENABLED_CONF.get();
+        BIOME_COLOR_INTENSITY = BIOME_COLOR_INTENSITY_CONF.get().floatValue();
+        CHEST_BUBBLES_ENABLED = CHEST_BUBBLES_ENABLED_CONF.get();
+        BARREL_BUBBLES_ENABLED = BARREL_BUBBLES_ENABLED_CONF.get();
+        CONTAINER_SOUND_ENABLED = CONTAINER_SOUND_ENABLED_CONF.get();
+        EXPLOSION_BUBBLES_ENABLED = EXPLOSION_BUBBLES_ENABLED_CONF.get();
+    }
 
 }

forge/src/main/java/net/tschipcraft/make_bubbles_pop/impl/BarrelBubbler.java

@@ -9,7 +9,6 @@
 import net.minecraft.world.level.Level;
 import net.minecraftforge.api.distmarker.Dist;
 import net.minecraftforge.api.distmarker.OnlyIn;
-import net.tschipcraft.make_bubbles_pop.MakeBubblesPop;
 import net.tschipcraft.make_bubbles_pop.MakeBubblesPopConfig;
 
 @OnlyIn(Dist.CLIENT)
@@ -20,7 +19,7 @@ private BarrelBubbler() {
     }
 
     public static void spawnBubbles(Level world, BlockPos pos, Direction facing, RandomSource random) {
-        if (world != null && world.isClientSide && (!MakeBubblesPop.MIDNIGHTLIB_INSTALLED || MakeBubblesPopConfig.BARREL_BUBBLES_ENABLED)) {
+        if (world != null && world.isClientSide && (MakeBubblesPopConfig.BARREL_BUBBLES_ENABLED)) {
             if (facing != Direction.DOWN) {
                 for (int i = 0; i < 6 + random.nextInt(12); i++) {
                     float xOffset = 0F;
@@ -73,7 +72,7 @@ public static void spawnBubbles(Level world, BlockPos pos, Direction facing, Ran
                     world.addParticle(ParticleTypes.BUBBLE, pos.getX() + xOffset + xOffsetRand, pos.getY() + yOffset + yOffsetRand, pos.getZ() + zOffset + zOffsetRand, xVelocityRand, 0.05F + random.nextFloat() * 0.05F, zVelocityRand);
                 }
                 // Play sound
-                if (!MakeBubblesPop.MIDNIGHTLIB_INSTALLED || MakeBubblesPopConfig.CONTAINER_SOUND_ENABLED) {
+                if (MakeBubblesPopConfig.CONTAINER_SOUND_ENABLED) {
                     world.playLocalSound(pos.getX(), pos.getY(), pos.getZ(), SoundEvents.BUBBLE_COLUMN_WHIRLPOOL_AMBIENT, SoundSource.AMBIENT, 0.3F + (random.nextFloat() * 0.1F), 1.3F + (random.nextFloat() * 0.3F), false);
                 }
             }

forge/src/main/java/net/tschipcraft/make_bubbles_pop/impl/BubbleUtil.java

@@ -9,7 +9,6 @@
 import net.minecraft.world.level.Level;
 import net.minecraftforge.api.distmarker.Dist;
 import net.minecraftforge.api.distmarker.OnlyIn;
-import net.tschipcraft.make_bubbles_pop.MakeBubblesPop;
 import net.tschipcraft.make_bubbles_pop.MakeBubblesPopConfig;
 
 @OnlyIn(Dist.CLIENT)
@@ -23,25 +22,25 @@ private BubbleUtil() {
      * Add a bubble pop particle and sound at the specified location in the world.
      */
     public static void popBubble(Level world, double x, double y, double z, double velocityX, double velocityY, double velocityZ) {
-        if (!MakeBubblesPop.MIDNIGHTLIB_INSTALLED || MakeBubblesPopConfig.POP_PARTICLE_ENABLED) {
+        if (MakeBubblesPopConfig.POP_PARTICLE_ENABLED) {
             world.addParticle(ParticleTypes.BUBBLE_POP, x, y, z,
-                    !MakeBubblesPop.MIDNIGHTLIB_INSTALLED || MakeBubblesPopConfig.POPPED_BUBBLES_MAINTAIN_VELOCITY ? velocityX : 0,
-                    !MakeBubblesPop.MIDNIGHTLIB_INSTALLED || MakeBubblesPopConfig.POPPED_BUBBLES_MAINTAIN_VELOCITY ? velocityY : 0,
-                    !MakeBubblesPop.MIDNIGHTLIB_INSTALLED || MakeBubblesPopConfig.POPPED_BUBBLES_MAINTAIN_VELOCITY ? velocityZ : 0
+                    MakeBubblesPopConfig.POPPED_BUBBLES_MAINTAIN_VELOCITY ? velocityX : 0D,
+                    MakeBubblesPopConfig.POPPED_BUBBLES_MAINTAIN_VELOCITY ? velocityY : 0D,
+                    MakeBubblesPopConfig.POPPED_BUBBLES_MAINTAIN_VELOCITY ? velocityZ : 0D
             );
-            world.playLocalSound(x, y, z, SoundEvents.BUBBLE_COLUMN_BUBBLE_POP, SoundSource.AMBIENT, (MakeBubblesPop.MIDNIGHTLIB_INSTALLED ? MakeBubblesPopConfig.BUBBLE_POP_VOLUME : 0.1F) - (world.random.nextFloat() * 0.1F), 0.85F + (world.random.nextFloat() * 0.3F), false);
+            world.playLocalSound(x, y, z, SoundEvents.BUBBLE_COLUMN_BUBBLE_POP, SoundSource.AMBIENT, (MakeBubblesPopConfig.BUBBLE_POP_VOLUME) - (world.random.nextFloat() * 0.1F), 0.85F + (world.random.nextFloat() * 0.3F), false);
         }
     }
 
     /**
      * Tint the calling bubble particle based on the water color.
      */
     public static void tintBubble(Level world, double x, double y, double z, TextureSheetParticle particle) {
-        if (!MakeBubblesPop.MIDNIGHTLIB_INSTALLED || MakeBubblesPopConfig.BIOME_COLORS_ENABLED) {
+        if (MakeBubblesPopConfig.BIOME_COLORS_ENABLED) {
             // Tint bubbles based on the water color
             int waterColor = BiomeColors.getAverageWaterColor(world, BlockPos.containing(x, y, z));
 
-            float intensity = (MakeBubblesPop.MIDNIGHTLIB_INSTALLED ? MakeBubblesPopConfig.BIOME_COLOR_INTENSITY : 0.65F);
+            float intensity = (MakeBubblesPopConfig.BIOME_COLOR_INTENSITY);
             float whiteMix = 1F - intensity;
             float cr = whiteMix + (intensity) * ((waterColor >> 16 & 0xFF) / 255F);
             float cg = whiteMix + (intensity) * ((waterColor >> 8 & 0xFF) / 255F);

forge/src/main/java/net/tschipcraft/make_bubbles_pop/mixin/client/BarrelBubble.java

@@ -9,7 +9,6 @@
 import net.minecraft.world.level.block.entity.BlockEntityTicker;
 import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.minecraft.world.level.block.state.BlockState;
-import net.tschipcraft.make_bubbles_pop.MakeBubblesPop;
 import net.tschipcraft.make_bubbles_pop.MakeBubblesPopConfig;
 import net.tschipcraft.make_bubbles_pop.impl.BarrelBlockEntityInterface;
 import net.tschipcraft.make_bubbles_pop.impl.BarrelBubbler;
@@ -42,7 +41,7 @@ public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, Block
 
     @Unique
     public <T extends BlockEntity> void makeBubblesPop$clientTick(Level world, BlockPos pos, BlockState state, T blockEntity) {
-        if (world != null && world.isClientSide && (!MakeBubblesPop.MIDNIGHTLIB_INSTALLED || MakeBubblesPopConfig.BARREL_BUBBLES_ENABLED)) {
+        if (world != null && world.isClientSide && (MakeBubblesPopConfig.BARREL_BUBBLES_ENABLED)) {
             // Get direction and openness of barrel block
             Direction facing = state.getOptionalValue(BarrelBlock.FACING).orElse(Direction.NORTH);
             boolean open = state.getOptionalValue(BarrelBlock.OPEN).orElse(false);