feat: port to 1.20.2 neoforge

Author: MichaelHillcox

.gitignore

@@ -27,3 +27,4 @@ CREDITS-fml.txt
 classes/
 .DS_Store
 /logs/
+runs/

CHANGELOG.md

@@ -2,5 +2,5 @@
 
 ### Changed
 
-- Updated to 1.20.2
+- Updated to 1.20.2 for NeoForge
 - Shifted versioning to be inline with Minecraft release numbers for the major game version (1.20.2 being 82 for example)

build.gradle

@@ -1,9 +1,10 @@
 plugins {
     id 'idea'
+    id 'java-library'
     id 'maven-publish'
-    id 'net.minecraftforge.gradle' version '[6.0.16,6.2)'
+    id 'net.neoforged.gradle.userdev' version '7.0.55'
+    id 'net.neoforged.gradle.mixin' version '7.0.55'
     id "me.modmuss50.mod-publish-plugin" version "0.4.5"
-    id 'org.spongepowered.mixin' version '0.7.+'
 }
 
 java.toolchain.languageVersion = JavaLanguageVersion.of(17)
@@ -12,53 +13,39 @@ version = mod_version
 group = 'pro.mikey'
 
 base {
-    archivesName = "advanced-xray-forge"
+    archivesName = "advanced-xray-neoforge"
 }
 
 mixin {
-    add sourceSets.main, 'xray.mixins.refmap.json'
     config 'xray.mixins.json'
 }
 
-minecraft {
-    mappings channel: "official", version: minecraft_version
+minecraft.accessTransformers.file rootProject.file('src/main/resources/META-INF/accesstransformer.cfg')
 
-    copyIdeResources = true
-    // See https://docs.minecraftforge.net/en/latest/advanced/accesstransformers/ for more information.
-    accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg')
+runs {
+    // applies to all the run configs below
+    configureEach {
+        systemProperty 'forge.logging.markers', 'REGISTRIES'
+        systemProperty 'forge.logging.console.level', 'debug'
 
-    runs {
-        // applies to all the run configs below
-        configureEach {
-            workingDirectory project.file('run')
-
-            property 'forge.logging.markers', 'REGISTRIES'
-            property 'forge.logging.console.level', 'debug'
-
-            mods {
-                "${mod_id}" {
-                    source sourceSets.main
-                }
-            }
-        }
+        modSource project.sourceSets.main
+    }
 
-        client {
-            property 'forge.enabledGameTestNamespaces', mod_id
-        }
+    client {
+        systemProperty 'forge.enabledGameTestNamespaces', project.mod_id
+    }
 
-        server {
-            property 'forge.enabledGameTestNamespaces', mod_id
-            args '--nogui'
-        }
+    server {
+        systemProperty 'forge.enabledGameTestNamespaces', mod_id
+        programArgument '--nogui'
+    }
 
-        gameTestServer {
-            property 'forge.enabledGameTestNamespaces', mod_id
-        }
+    gameTestServer {
+        systemProperty 'forge.enabledGameTestNamespaces', mod_id
+    }
 
-        data {
-            workingDirectory project.file('run-data')
-            args '--mod', mod_id, '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/')
-        }
+    data {
+        programArguments.addAll '--mod', project.mod_id, '--all', '--output', file('src/generated/resources/').getAbsolutePath(), '--existing', file('src/main/resources/').getAbsolutePath()
     }
 }
 
@@ -81,8 +68,8 @@ processResources {
 }
 
 dependencies {
-    minecraft "net.minecraftforge:forge:${minecraft_version}-${forge_version}"
-    annotationProcessor 'org.spongepowered:mixin:0.8.5:processor'
+    implementation "net.neoforged:neoforge:${forge_version}"
+
 }
 
 repositories {
@@ -119,7 +106,7 @@ publishing {
     publications {
         mavenJava(MavenPublication) {
             artifactId = rootProject.archivesBaseName
-            artifact jar
+            from components.java
         }
     }
 
@@ -147,8 +134,8 @@ publishMods {
         accessToken = providers.environmentVariable("CURSE_DEPLOY_TOKEN")
         projectId = "${curse_id}"
         minecraftVersions.add("${minecraft_version}")
-        modLoaders.add("forge")
-        displayName = "[FORGE] [${minecraft_version}] ${project.name} ${mod_version}"
+        modLoaders.add("neoforge")
+        displayName = "[NEOFORGE] [${minecraft_version}] ${project.name} ${mod_version}"
         file = project.tasks.jar.archiveFile
     }
 

gradle.properties

@@ -8,7 +8,5 @@ minecraft_version=1.20.2
 minecraft_version_range=[%base],1.20.3
 
 # Forge
-forge_version=48.0.49
+forge_version= 20.2.86
 curse_id=256256
-
-loom.platform=forge

settings.gradle

@@ -7,4 +7,4 @@ pluginManagement {
     }
 }
 
-rootProject.name = 'advanced-xray-forge'
+rootProject.name = 'advanced-xray-neoforge'

src/main/java/pro/mikey/xray/ClientController.java

@@ -5,14 +5,14 @@
 import net.minecraft.client.resources.language.I18n;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.entity.player.Player;
-import net.minecraftforge.common.MinecraftForge;
-import net.minecraftforge.event.entity.EntityJoinLevelEvent;
-import net.minecraftforge.eventbus.api.IEventBus;
-import net.minecraftforge.fml.ModLoadingContext;
-import net.minecraftforge.fml.config.ModConfig;
-import net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent;
-import net.minecraftforge.fml.event.lifecycle.FMLLoadCompleteEvent;
-import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
+import net.neoforged.bus.api.IEventBus;
+import net.neoforged.fml.ModLoadingContext;
+import net.neoforged.fml.config.ModConfig;
+import net.neoforged.fml.event.lifecycle.FMLCommonSetupEvent;
+import net.neoforged.fml.event.lifecycle.FMLLoadCompleteEvent;
+import net.neoforged.fml.javafmlmod.FMLJavaModLoadingContext;
+import net.neoforged.neoforge.common.NeoForge;
+import net.neoforged.neoforge.event.entity.EntityJoinLevelEvent;
 import pro.mikey.xray.keybinding.KeyBindings;
 import pro.mikey.xray.store.BlockStore;
 import pro.mikey.xray.store.DiscoveryStorage;
@@ -39,11 +39,11 @@ public static void setup() {
         ModLoadingContext.get().registerConfig(ModConfig.Type.CLIENT, Configuration.SPEC);
 
         // Keybindings
-        MinecraftForge.EVENT_BUS.register(KeyBindings.class);
-        MinecraftForge.EVENT_BUS.addListener(ClientController::onGameJoin);
+        NeoForge.EVENT_BUS.register(KeyBindings.class);
+        NeoForge.EVENT_BUS.addListener(ClientController::onGameJoin);
 
-        MinecraftForge.EVENT_BUS.addListener(Events::tickEnd);
-        MinecraftForge.EVENT_BUS.addListener(Events::onWorldRenderLast);
+        NeoForge.EVENT_BUS.addListener(Events::tickEnd);
+        NeoForge.EVENT_BUS.addListener(Events::onWorldRenderLast);
 
     }
 

src/main/java/pro/mikey/xray/Configuration.java

@@ -1,21 +1,22 @@
 package pro.mikey.xray;
 
-import net.minecraftforge.common.ForgeConfigSpec;
+
+import net.neoforged.neoforge.common.ModConfigSpec;
 
 public class Configuration
 {
-    private static final ForgeConfigSpec.Builder BUILDER = new ForgeConfigSpec.Builder();
+    private static final ModConfigSpec.Builder BUILDER = new ModConfigSpec.Builder();
 
     public static final General general = new General();
     public static final Store store = new Store();
 
-    public static final ForgeConfigSpec.BooleanValue firstRun = BUILDER
+    public static final ModConfigSpec.BooleanValue firstRun = BUILDER
             .comment("DO NOT TOUCH!", "This is not for you.", "This is used to check if it's the first time the mod has been run")
             .define("firstRun", true);
 
     public static class General {
-        public final ForgeConfigSpec.BooleanValue showOverlay;
-        public final ForgeConfigSpec.DoubleValue outlineThickness;
+        public final ModConfigSpec.BooleanValue showOverlay;
+        public final ModConfigSpec.DoubleValue outlineThickness;
 
         General() {
             BUILDER.push("general");
@@ -34,8 +35,8 @@ public static class General {
     }
 
     public static class Store {
-        public final ForgeConfigSpec.IntValue radius;
-        public final ForgeConfigSpec.BooleanValue lavaActive;
+        public final ModConfigSpec.IntValue radius;
+        public final ModConfigSpec.BooleanValue lavaActive;
 
         Store() {
             BUILDER.comment("DO NOT TOUCH!").push("store");
@@ -52,5 +53,5 @@ public static class Store {
         }
     }
 
-    public static final ForgeConfigSpec SPEC = BUILDER.build();
+    public static final ModConfigSpec SPEC = BUILDER.build();
 }

src/main/java/pro/mikey/xray/XRay.java

@@ -1,10 +1,10 @@
 package pro.mikey.xray;
 
-import net.minecraftforge.api.distmarker.Dist;
-import net.minecraftforge.fml.DistExecutor;
-import net.minecraftforge.fml.IExtensionPoint;
-import net.minecraftforge.fml.ModLoadingContext;
-import net.minecraftforge.fml.common.Mod;
+import net.neoforged.api.distmarker.Dist;
+import net.neoforged.fml.DistExecutor;
+import net.neoforged.fml.IExtensionPoint;
+import net.neoforged.fml.ModLoadingContext;
+import net.neoforged.fml.common.Mod;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 

src/main/java/pro/mikey/xray/gui/GuiOverlay.java

@@ -5,12 +5,12 @@
 import net.minecraft.client.gui.GuiGraphics;
 import net.minecraft.client.resources.language.I18n;
 import net.minecraft.resources.ResourceLocation;
-import net.minecraftforge.api.distmarker.Dist;
-import net.minecraftforge.api.distmarker.OnlyIn;
-import net.minecraftforge.client.event.RenderGuiOverlayEvent;
-import net.minecraftforge.eventbus.api.EventPriority;
-import net.minecraftforge.eventbus.api.SubscribeEvent;
-import net.minecraftforge.fml.common.Mod;
+import net.neoforged.api.distmarker.Dist;
+import net.neoforged.api.distmarker.OnlyIn;
+import net.neoforged.bus.api.EventPriority;
+import net.neoforged.bus.api.SubscribeEvent;
+import net.neoforged.fml.common.Mod;
+import net.neoforged.neoforge.client.event.RenderGuiOverlayEvent;
 import pro.mikey.xray.Configuration;
 import pro.mikey.xray.XRay;
 import pro.mikey.xray.xray.Controller;
@@ -21,9 +21,9 @@ public class GuiOverlay {
 
     @OnlyIn(Dist.CLIENT)
     @SubscribeEvent(priority = EventPriority.LOWEST)
-    public static void RenderGameOverlayEvent(RenderGuiOverlayEvent event) {
+    public static void RenderGameOverlayEvent(RenderGuiOverlayEvent.Post event) {
         // Draw Indicator
-        if(!Controller.isXRayActive() || !Configuration.general.showOverlay.get() || event.isCanceled())
+        if(!Controller.isXRayActive() || !Configuration.general.showOverlay.get())
             return;
 
         RenderSystem.setShaderColor(0, 1F, 0, 1F);

src/main/java/pro/mikey/xray/gui/manage/GuiAddBlock.java

@@ -1,18 +1,17 @@
 package pro.mikey.xray.gui.manage;
 
-import com.mojang.blaze3d.platform.Lighting;
-import com.mojang.blaze3d.vertex.PoseStack;
+
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.GuiGraphics;
 import net.minecraft.client.gui.components.Button;
 import net.minecraft.client.gui.components.EditBox;
 import net.minecraft.client.resources.language.I18n;
+import net.minecraft.core.registries.BuiltInRegistries;
 import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.block.Block;
-import net.minecraftforge.client.gui.widget.ForgeSlider;
-import net.minecraftforge.registries.ForgeRegistries;
+import net.neoforged.neoforge.client.gui.widget.ExtendedSlider;
 import pro.mikey.xray.ClientController;
 import pro.mikey.xray.gui.GuiSelectionScreen;
 import pro.mikey.xray.gui.utils.GuiBase;
@@ -25,9 +24,9 @@
 
 public class GuiAddBlock extends GuiBase {
     private EditBox oreName;
-    private ForgeSlider redSlider;
-    private ForgeSlider greenSlider;
-    private ForgeSlider blueSlider;
+    private ExtendedSlider redSlider;
+    private ExtendedSlider greenSlider;
+    private ExtendedSlider blueSlider;
 
     private final Block selectBlock;
     private final ItemStack itemStack;
@@ -49,7 +48,7 @@ public void init() {
         addRenderableWidget(Button.builder(Component.translatable("xray.single.add"), b -> {
             this.onClose();
 
-            ResourceLocation key = ForgeRegistries.BLOCKS.getKey(selectBlock);
+            ResourceLocation key = BuiltInRegistries.BLOCK.getKey(selectBlock);
             if (key == null)
                 return;
 
@@ -80,9 +79,9 @@ public void init() {
                 .size(72, 20)
                 .build());
 
-        addRenderableWidget(redSlider = new ForgeSlider(getWidth() / 2 - 100, getHeight() / 2 + 7, 202, 20, Component.translatable("xray.color.red"), Component.empty(), 0, 255, 0, true));
-        addRenderableWidget(greenSlider = new ForgeSlider(getWidth() / 2 - 100, getHeight() / 2 + 30, 202, 20, Component.translatable("xray.color.green"), Component.empty(), 0, 255, 165, true));
-        addRenderableWidget(blueSlider = new ForgeSlider(getWidth() / 2 - 100, getHeight() / 2 + 53,202, 20,  Component.translatable("xray.color.blue"), Component.empty(), 0, 255, 255, true));
+        addRenderableWidget(redSlider = new ExtendedSlider(getWidth() / 2 - 100, getHeight() / 2 + 7, 202, 20, Component.translatable("xray.color.red"), Component.empty(), 0, 255, 0, true));
+        addRenderableWidget(greenSlider = new ExtendedSlider(getWidth() / 2 - 100, getHeight() / 2 + 30, 202, 20, Component.translatable("xray.color.green"), Component.empty(), 0, 255, 165, true));
+        addRenderableWidget(blueSlider = new ExtendedSlider(getWidth() / 2 - 100, getHeight() / 2 + 53,202, 20,  Component.translatable("xray.color.blue"), Component.empty(), 0, 255, 255, true));
 
         oreName = new EditBox(getMinecraft().font, getWidth() / 2 - 100, getHeight() / 2 - 70, 202, 20, Component.empty());
         oreName.setValue(this.selectBlock.getName().getString());