Add option to disable the decompilation+recompilation pipeline (#304)

Co-authored-by: Sebastian Hartte <[email protected]>

Author: Technici4n

.github/workflows/build-prs.yml

@@ -26,11 +26,15 @@ jobs:
 
   test-project:
     strategy:
+      max-parallel: 6
       matrix:
         os: [ubuntu-latest, windows-latest]
         project: [testproject, legacytest]
+        recomp: ["recomp", "no recomp"]
     runs-on: ${{ matrix.os }}
-    name: Test ${{ matrix.project }} on ${{ matrix.os }}
+    name: Test ${{ matrix.project }} on ${{ matrix.os }} (${{ matrix.recomp }})
+    env:
+      CI: ${{ matrix.recomp == 'no recomp' }}
     steps:
       - name: Checkout project sources
         uses: neoforged/actions/checkout@main

LEGACY.md

@@ -103,6 +103,19 @@ legacyForge {
 }
 ```
 
+## Disabling Decompilation and Recompilation
+As of MDG Legacy 2.0.124, the decompilation/recompilation pipeline can be disabled, similarly to the regular plugin.
+To disable it in CI, use the following:
+```groovy
+legacyForge {
+    enable {
+        forgeVersion = "..." // or mcpVersion = "..." if running in Vanilla mode
+        // Disable recompilation if the "CI" environment variable is set to true. It is automatically set by GitHub Actions.
+        disableRecompilation = System.getenv("CI") == "true"
+    }
+}
+```
+
 ## Mixins
 
 You need to create so-called "refmaps" for Mixin, which convert the names you used to declare injection points and reference other parts of Minecraft code to the names used at runtime (SRG).

README.md

@@ -108,6 +108,30 @@ neoForge {
 }
 ```
 
+## Disabling Decompilation and Recompilation
+By default, MDG will use the [NeoForm](https://github.com/neoforged/NeoForm) decompilation/recompilation pipeline to produce
+Minecraft sources and a matching compiled game jar. This leads to a great debugging experience, at the cost of longer setup times.
+
+As of MDG 2.0.124, an alternative pipeline can be used, which will skip decompilation and recompilation entirely!
+We recommend leaving recompilation on by default, but disabling it when running on CI such as GitHub Actions.
+
+To do so, replace:
+```groovy
+neoForge {
+    version = "..." // or neoFormVersion = "..."
+}
+```
+By:
+```groovy
+neoForge {
+    enable {
+        version = "..." // or neoFormVersion = "..."
+        // Disable recompilation if the "CI" environment variable is set to true. It is automatically set by GitHub Actions.
+        disableRecompilation = System.getenv("CI") == "true"
+    }
+}
+```
+
 ## Common Issues
 
 ### Clicking "Attach Sources" does nothing when viewing a Minecraft class (IntelliJ IDEA)

legacytest/build.gradle

@@ -13,7 +13,10 @@ java {
 }
 
 legacyForge {
-    mcpVersion = '1.19.2'
+    enable {
+        mcpVersion = '1.19.2'
+        disableRecompilation = System.getenv("CI") == "true"
+    }
 }
 
 publishing {

legacytest/forge/build.gradle

@@ -4,7 +4,6 @@ plugins {
 }
 
 repositories {
-    mavenLocal()
     maven {
         name = "Jared's maven"
         url = "https://maven.blamejared.com/"
@@ -33,7 +32,10 @@ dependencies {
 }
 
 legacyForge {
-    version = '1.20.1-47.3.12'
+    enable {
+        forgeVersion = '1.20.1-47.3.12'
+        disableRecompilation = System.getenv("CI") == "true"
+    }
     runs {
         client {
             client()

legacytest/forge/src/main/java/mymod/MyMod.java

@@ -1,6 +1,10 @@
 package mymod;
 
 import net.minecraft.DetectedVersion;
+import net.minecraft.core.BlockPos;
+import net.minecraft.server.level.ServerLevel;
+import net.minecraft.world.level.block.EnderChestBlock;
+import net.minecraft.world.level.block.state.BlockBehaviour;
 import net.minecraftforge.fml.common.Mod;
 
 @Mod("mymod")
@@ -9,6 +13,13 @@ public void run() {
         DetectedVersion.tryDetectVersion();
     }
 
+    public static void doStuff() {
+        // Test our AT
+        ServerLevel.END_SPAWN_POINT = new BlockPos(1, 2, 3);
+        // Test a Forge AT (in a class that is not binpatched)
+        var block = new EnderChestBlock(BlockBehaviour.Properties.of());
+    }
+
     @javax.annotation.Nullable
     private static Object javaxNullableTest() {
         return null;

legacytest/forge/src/main/resources/META-INF/accesstransformer.cfg

@@ -0,0 +1 @@
+public-f net.minecraft.server.level.ServerLevel f_8562_ # END_SPAWN_POINT

legacytest/forgedownstream/build.gradle

@@ -16,7 +16,10 @@ dependencies {
 }
 
 legacyForge {
-    version = '1.20.1-47.3.0'
+    enable {
+        forgeVersion = '1.20.1-47.3.0'
+        disableRecompilation = System.getenv("CI") == "true"
+    }
 }
 
 var copyJarJar = tasks.register('copyJarJar', Copy) {

src/legacy/java/net/neoforged/moddevgradle/legacyforge/dsl/LegacyForgeModdingSettings.java

@@ -20,6 +20,8 @@ public abstract class LegacyForgeModdingSettings {
 
     private Set<SourceSet> enabledSourceSets = new HashSet<>();
 
+    private boolean disableRecompilation = false;
+
     private boolean obfuscateJar = true;
 
     @Inject
@@ -78,6 +80,21 @@ public void setEnabledSourceSets(Set<SourceSet> enabledSourceSets) {
         this.enabledSourceSets = enabledSourceSets;
     }
 
+    /**
+     * {@code true} if MDG should skip the NeoForm decompilation/recompilation pipeline,
+     * and instead apply transforms on the .class files and use binary patches.
+     * This leads to a faster setup since Minecraft doesn't need to be decompiled,
+     * however source files will not be available.
+     * {@code false} by default.
+     */
+    public boolean isDisableRecompilation() {
+        return disableRecompilation;
+    }
+
+    public void setDisableRecompilation(boolean disableRecompilation) {
+        this.disableRecompilation = disableRecompilation;
+    }
+
     /**
      * {@return true if default reobfuscation task should be created}
      */

src/legacy/java/net/neoforged/moddevgradle/legacyforge/internal/LegacyForgeModDevPlugin.java

@@ -153,7 +153,8 @@ public void enable(Project project, LegacyForgeModdingSettings settings, LegacyF
                 artifactNamingStrategy,
                 configurations.getByName(DataFileCollections.CONFIGURATION_ACCESS_TRANSFORMERS),
                 configurations.getByName(DataFileCollections.CONFIGURATION_INTERFACE_INJECTION_DATA),
-                versionCapabilities);
+                versionCapabilities,
+                settings.isDisableRecompilation());
 
         var runs = ModDevRunWorkflow.create(
                 project,