Legacy plugin for 1.17 to 1.20.1

.github/workflows/build-prs.yml

@@ -28,8 +28,9 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
+        project: [testproject, legacytest]
     runs-on: ${{ matrix.os }}
-    name: Test on ${{ matrix.os }}
+    name: Test ${{ matrix.project }} on ${{ matrix.os }}
     steps:
       - name: Checkout project sources
         uses: actions/checkout@v4
@@ -46,13 +47,13 @@ jobs:
         uses: gradle/actions/setup-gradle@v3
 
       - name: Run build
-        run: ./gradlew build neoForgeIdeSync
-        working-directory: ./testproject
+        run: ./gradlew build neoForgeIdeSync publish
+        working-directory: ./${{ matrix.project }}
 
       - name: Ensure clean, build and test work in the same run
         run: ./gradlew clean build check
-        working-directory: ./testproject
+        working-directory: ./${{ matrix.project }}
 
       - name: Ensure runData runs
         run: ./gradlew runData
-        working-directory: ./testproject
+        working-directory: ./${{ matrix.project }}

LEGACY.md

@@ -0,0 +1,100 @@
+# ModDevGradle Legacy Forge Plugin
+ModDevGradle has a secondary plugin (ID: `net.neoforged.moddev.legacyforge`, released alongside the normal plugin with the same version)
+that adds support for developing mods against MinecraftForge and Vanilla Minecraft versions 1.17 up to 1.20.1.  
+
+The legacy plugin is an "addon" plugin, meaning it operates on top of the normal plugin. This means that the APIs normally used
+are also available when using the legacy plugin.
+
+## Basic Usage for MinecraftForge Mods
+An example `build.gradle` file for developing a mod against MinecraftForge for 1.20.1 is provided below:
+```groovy
+plugins {
+    // Apply the plugin. You can find the latest version at https://projects.neoforged.net/neoforged/ModDevGradle
+    id 'net.neoforged.moddev.legacyforge' version '2.0.28-beta'
+}
+
+neoForge {
+    // Develop against MinecraftForge version 47.3.0 for 1.20.1 (the versions can be found at https://files.minecraftforge.net/)
+    version = "1.20.1-47.3.0"
+
+    // Validate AT files and raise errors when they have invalid targets
+    // This option is false by default, but turning it on is recommended
+    validateAccessTransformers = true
+
+    runs {
+        client {
+            client()
+        }
+        data {
+            data()
+        }
+        server {
+            server()
+        }
+    }
+
+    mods {
+        testproject {
+            sourceSet sourceSets.main
+        }
+    }
+}
+```
+
+## Reobfuscating artifacts
+Forge used SRG mappings as intermediary mappings in 1.20.1 and below. While your mod is developed against the mappings provided
+by Mojang (known as official mappings), you need to reobfuscate it to SRG mappings for it to work in production.  
+Reobfuscation will automatically be configured for the `jar` task; the non-obfuscated jar will have a `-dev` classifier
+and will not be published in favour of the reobfuscated variant. You should upload the `reobfJar` task's output when using a
+task to upload to a mod hosting platform, or otherwise the jar without a `-dev` classifier if you're uploading it manually.  
+
+You may reobfuscate other jar tasks using `obfuscation.reobfuscate(TaskProvider<AbstractArchiveTask>, SourceSet, Action<RemapJarTask>)`.  
+For instance, if you want to reobfuscate a `shadowJar` task:
+```groovy
+shadowJar {
+    // Change the classifier of the shadow jar to be -dev-all as it's not mapped in intermediary and not usable for production
+    archiveClassifier = 'dev-all'
+}
+
+obfuscation {
+    // Reobfuscate the shadowJar task, using the classpath of the main sourceset for properly remapping inherited members
+    reobfuscate(tasks.named('shadowJar'), sourceSets.main) {
+        // Make the reobfuscated shadowJar have the all classifier
+        // You could also change it to an empty string if you want it to not have a classifier (in that case, you will also need to change the classifier of the slim `reobfJar` task
+        archiveClassifier = 'all'
+    }
+}
+```
+
+When reobfuscating a jar, it will be replaced in publications with the obfuscated version to avoid publishing jars that aren't mapped to SRG.
+
+## Remapping mod dependencies
+As published mods are using intermediary mappings, you must remap them to official mappings before being able to use them as a dependencies.  
+ModDevGradle creates configurations that will automatically remap dependencies added to them from SRG mappings to official mappings.  
+The following configurations are created automatically and are children of the configurations without the `mod` prefix:
+- `modImplementation`
+- `modRuntimeOnly`
+- `modCompileOnly`
+- `modApi` (only if the `java-library` plugin is applied)
+- `modCompileOnlyApi` (only if the `java-library` plugin is applied)
+
+You may create your own remapping configurations using `obfuscation.createRemappingConfiguration(Configuration)`:
+```groovy
+configurations {
+    // Create a custom configuration named "custom"
+    custom
+}
+
+obfuscation {
+    // Create a configuration named "modCustom" that remaps its dependencies and then adds them to the "custom" configuration
+    createRemappingConfiguration(configurations.custom)
+}
+```
+
+## Effects of applying the legacy plugin
+When applied, the legacy plugin will change the base NeoForm and NeoForge artifact coordinates of the `neoForge` extension to
+`de.oceanlabs.mcp:mcp_config` and `net.minecraftforge:forge`.  
+It will also trigger the creation of various intermediary (SRG) to named (official) mapping files used by various parts of the toolchain, such as
+mod reobfuscation and runtime naming services.  
+Reobfuscation to the intermediary mappings will automatically be configured for the `jar` task, the non-obfuscated jar will have a `-dev` classifier
+and will not be published in favour of the reobfuscated variant.

build.gradle

@@ -70,13 +70,15 @@ sourceSets {
         compileClasspath += java8.output
         runtimeClasspath += java8.output
     }
+    legacy
 }
 
 configurations {
     // Configuration for all dependencies that we want shaded.
     shaded
     // Place shaded dependencies into `compileOnly` so that they do not leak into our publications' dependencies.
     compileOnly.extendsFrom shaded
+    legacyCompileOnly.extendsFrom shaded
     testCompileOnly.extendsFrom shaded
     testRuntimeOnly.extendsFrom shaded
     shadowRuntimeElements {
@@ -123,6 +125,10 @@ dependencies {
     testImplementation gradleTestKit()
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+
+    legacyImplementation(sourceSets.main.output)
+    legacyImplementation(sourceSets.java8.output)
+    legacyImplementation gradleApi()
 }
 
 java {
@@ -135,12 +141,14 @@ java {
 jar {
     archiveClassifier = 'slim'
     from sourceSets.java8.output
+    from sourceSets.legacy.output
 }
 
 shadowJar {
     archiveClassifier = "" // Required for the Plugin Publish Plugin to publish this jar
 
     from sourceSets.java8.output
+    from sourceSets.legacy.output
 
     configurations = [project.configurations.shaded]
     enableRelocation = true
@@ -188,6 +196,13 @@ gradlePlugin {
             description = "This plugin helps you create Minecraft mods using the NeoForge platform"
             tags = ["minecraft", "neoforge", "java", "mod"]
         }
+        legacyforge {
+            id = 'net.neoforged.moddev.legacyforge'
+            implementationClass = 'net.neoforged.moddevgradle.boot.LegacyForgeModDevPlugin'
+            displayName = "Mod Development Plugin for Legacy Forge"
+            description = "This plugin helps you create Minecraft mods using the Forge platform, up to 1.20.1"
+            tags = ["minecraft", "neoforge", "forge", "java", "mod"]
+        }
         repositories {
             id = 'net.neoforged.moddev.repositories'
             implementationClass = 'net.neoforged.moddevgradle.boot.RepositoriesPlugin'
@@ -212,21 +227,7 @@ artifacts {
 
 publishing {
     repositories {
-        maven {
-            name = 'NeoForge'
-            if (System.getenv('MAVEN_USER') && System.getenv('MAVEN_PASSWORD')) {
-                it.url = "https://maven.neoforged.net/releases/"
-                it.authentication {
-                    it.create('basic', BasicAuthentication)
-                }
-                it.credentials { credentials ->
-                    credentials.username = System.getenv('MAVEN_USER')
-                    credentials.password = System.getenv('MAVEN_PASSWORD')
-                }
-            } else {
-                it.url = 'file://' + file("repo").getAbsolutePath()
-            }
-        }
+        maven(gradleutils.publishingMaven)
     }
 }
 

legacytest/.gitignore

@@ -0,0 +1,3 @@
+run/
+repo/
+*.log

legacytest/build.gradle

@@ -0,0 +1,30 @@
+plugins {
+    id 'maven-publish'
+    id 'net.neoforged.moddev.legacyforge'
+}
+
+group = 'com.example.legacy'
+version = '1.0.0'
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
+}
+
+neoForge {
+    neoFormVersion = '1.19.2'
+}
+
+publishing {
+    publications {
+        maven(MavenPublication) {
+            from components.java
+        }
+    }
+    repositories {
+        maven {
+            url file('local')
+        }
+    }
+}

legacytest/forge/build.gradle

@@ -0,0 +1,66 @@
+plugins {
+    id 'net.neoforged.moddev.legacyforge'
+    id 'maven-publish'
+}
+
+repositories {
+    mavenLocal()
+    maven {
+        name = "Jared's maven"
+        url = "https://maven.blamejared.com/"
+    }
+    maven {
+        name 'cursemaven'
+        url 'https://cursemaven.com'
+        content {
+            includeGroup "curse.maven"
+        }
+    }
+}
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
+}
+
+dependencies {
+    modCompileOnly('mezz.jei:jei-1.20.1-forge:15.17.0.76') {
+        transitive = false // JEI publishes dependencies on its subprojects that are already included in this Jar
+    }
+    modRuntimeOnly('curse.maven:mekanism-268560:5662583')
+    modImplementation('curse.maven:applied-energistics-2-223794:5641282')
+    // This is an example for a mod that does NOT work with FG or MDG since its JiJ dependencies are
+    // packages into /META-INF/jars while installertools will only remap /META-INF/jarjar/*.jar
+    // modImplementation('curse.maven:gregtechceu-modern-890405:5641637')
+}
+
+neoForge {
+    version = '1.20.1-47.3.0'
+    runs {
+        client {
+            client()
+        }
+        data {
+            data()
+        }
+    }
+    mods {
+        myMod {
+            sourceSet(sourceSets.main)
+        }
+    }
+}
+
+publishing {
+    publications {
+        maven(MavenPublication) {
+            from components.java
+        }
+    }
+    repositories {
+        maven {
+            url rootProject.file('repo')
+        }
+    }
+}

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

@@ -0,0 +1,21 @@
+package mymod;
+
+import mezz.jei.api.IModPlugin;
+import mezz.jei.api.JeiPlugin;
+import mezz.jei.api.registration.ISubtypeRegistration;
+import net.minecraft.resources.ResourceLocation;
+import net.minecraft.world.item.Items;
+
+@JeiPlugin
+public class JeiCompat implements IModPlugin {
+    @Override
+    public ResourceLocation getPluginUid() {
+        return new ResourceLocation("mymod:mymod");
+    }
+
+    @Override
+    public void registerItemSubtypes(ISubtypeRegistration registration) {
+        // Calling this method tests that JEI was remapped correctly, since the method has an "ItemStack" argument
+        registration.registerSubtypeInterpreter(Items.ALLIUM, (ingredient, context) -> "allium");
+    }
+}

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

@@ -0,0 +1,9 @@
+package mymod;
+
+import net.minecraftforge.fml.common.Mod;
+
+@Mod("mymod")
+public class MyMod {
+    public void run() {
+    }
+}

legacytest/forge/src/main/resources/META-INF/mods.toml

@@ -0,0 +1,12 @@
+modLoader="javafml" #mandatory
+loaderVersion="*" #mandatory This is typically bumped every Minecraft version by Forge. See our download page for lists of versions.
+license="ARR"
+[[mods]] #mandatory
+# The modid of the mod
+modId="mymod" #mandatory
+# The version number of the mod
+version="1.0" #mandatory
+# A display name for the mod
+displayName="My Mod" #mandatory
+authors="MDG" #optional
+description='''Hi.'''

legacytest/gradle.properties

@@ -0,0 +1 @@
+org.gradle.configuration-cache=true

legacytest/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-all.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists