Update MDK to use FG7 (#10923)

build.gradle

@@ -1632,6 +1632,12 @@ project(':forge') {
         }
     }
 
+    final mdkGradleWrapper = tasks.register('mdkGradleWrapper', Wrapper) {
+        gradleVersion = "9.8.2"
+        scriptFile = layout.buildDirectory.dir("wrapper/" + gradleVersion + "/gradlew")
+        jarFile = layout.buildDirectory.dir("wrapper/" + gradleVersion + "/gradle/wrapper/gradle-wrapper.jar")
+    }
+
     task makeMdk(type: Zip) {
         archiveBaseName = project.name
         archiveClassifier = 'mdk'
@@ -1641,8 +1647,9 @@ project(':forge') {
         from rootProject.file('gradlew')
         from rootProject.file('gradlew.bat')
         from extraTxts
-        from(rootProject.file('gradle/')){
-            into('gradle/')
+        into('gradle/wrapper/') {
+            from mdkGradleWrapper.map(Wrapper.&getJarFile)
+            from mdkGradleWrapper.map(Wrapper.&getPropertiesFile)
         }
         from(rootProject.file('mdk/')){
             rootProject.file('mdk/gitignore.txt').eachLine{

mdk/build.gradle

@@ -1,156 +1,87 @@
+// Don't see a feature you're wanting to use?
+// See our MDKExamples repository for minimal examples for features like JarInJar
+// https://github.com/MinecraftForge/MDKExamples
 plugins {
     id 'eclipse'
     id 'idea'
+    id 'java'
     id 'maven-publish'
-    id 'net.minecraftforge.gradle' version '[6.0,6.2)'
+    id 'net.minecraftforge.gradle' version '[7.0,8)'
+    id 'net.minecraftforge.renamer' version '1.1.8+' // Required on all versions which use SRG maps at runtime.
 }
 
-version = mod_version
-group = mod_group_id
-
-base {
-    archivesName = mod_id
-}
+version = '1.0'
+group = 'com.example'
+base.archivesName = 'examplemod'
 
 // Mojang ships Java 17 to end users in 1.18+, so your mod should target Java 17.
 java.toolchain.languageVersion = JavaLanguageVersion.of(17)
 
-println "Java: ${System.getProperty 'java.version'}, JVM: ${System.getProperty 'java.vm.version'} (${System.getProperty 'java.vendor'}), Arch: ${System.getProperty 'os.arch'}"
+println "Java: ${providers.systemProperty('java.version').get()}, " +
+        "JVM: ${providers.systemProperty('java.vm.version').get()} (${providers.systemProperty('java.vendor').get()}), " +
+        "Arch: ${providers.systemProperty('os.arch').get()}"
+
 minecraft {
-    // The mappings can be changed at any time and must be in the following format.
-    // Channel:   Version:
-    // official   MCVersion             Official field/method names from Mojang mapping files
-    // parchment  YYYY.MM.DD-MCVersion  Open community-sourced parameter names and javadocs layered on top of official
-    //
-    // You must be aware of the Mojang license when using the 'official' or 'parchment' mappings.
-    // See more information here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
-    //
-    // Parchment is an unofficial project maintained by ParchmentMC, separate from MinecraftForge
-    // Additional setup is needed to use their mappings: https://parchmentmc.org/docs/getting-started
-    //
-    // Use non-default mappings at your own risk. They may not always work.
-    // Simply re-run your setup task after changing the mappings to update your workspace.
-    mappings channel: mapping_channel, version: mapping_version
+    // Declare which mappings to use
+    mappings channel: mapping_channel, version: minecraft_version
 
-    // When true, this property will have all Eclipse/IntelliJ IDEA run configurations run the "prepareX" task for the given run configuration before launching the game.
-    // In most cases, it is not necessary to enable.
-    // enableEclipsePrepareRuns = true
-    // enableIdeaPrepareRuns = true
+    // Access Transformer files may now be automatically detected, or explicitly declared.
+    // Setting the below flag will cause ForgeGradle to look for META-INF/accesstransformer.cfg
+    // Alternatively, provide it a file(<path>) or files(<paths>) for explicitly declared files. If you use any
+    // explicitly declared access transformers, all transformers must be also declared in the mods.toml
+    // accessTransformer = true
 
-    // This property allows configuring Gradle's ProcessResources task(s) to run on IDE output locations before launching the game.
-    // It is REQUIRED to be set to true for this template to function.
-    // See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
-    copyIdeResources = true
-
-    // When true, this property will add the folder name of all declared run configurations to generated IDE run configurations.
-    // The folder name can be set on a run configuration using the "folderName" property.
-    // By default, the folder name of a run configuration is the name of the Gradle project containing it.
-    // generateRunFolders = true
-
-    // This property enables access transformers for use in development.
-    // They will be applied to the Minecraft artifact.
-    // The access transformer file can be anywhere in the project.
-    // However, it must be at "META-INF/accesstransformer.cfg" in the final mod jar to be loaded by Forge.
-    // This default location is a best practice to automatically put the file in the right place in the final jar.
-    // See https://docs.minecraftforge.net/en/latest/advanced/accesstransformers/ for more information.
-    // accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg')
-
-    // Default run configurations.
-    // These can be tweaked, removed, or duplicated as needed.
     runs {
-        // applies to all the run configs below
         configureEach {
-            workingDirectory project.file('run')
+            workingDir.convention layout.projectDirectory.dir('run')
 
-            // Recommended logging data for a userdev environment
-            // The markers can be added/remove as needed separated by commas.
-            // "SCAN": For mods scan.
-            // "REGISTRIES": For firing of registry events.
-            // "REGISTRYDUMP": For getting the contents of all registries.
-            property 'forge.logging.markers', 'REGISTRIES'
+            //systemProperty 'forge.logging.markers', 'REGISTRIES'
 
-            // Recommended logging level for the console
-            // You can set various levels here.
-            // Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
-            property 'forge.logging.console.level', 'debug'
-
-            mods {
-                "${mod_id}" {
-                    source sourceSets.main
-                }
-            }
+            //args "-mixin.config=${mod_id}.mixins.json"
         }
 
-        client {
-            // Comma-separated list of namespaces to load gametests from. Empty = all namespaces.
-            property 'forge.enabledGameTestNamespaces', mod_id
+        register('client') {
+            systemProperty 'forge.enabledGameTestNamespaces', mod_id
         }
 
-        server {
-            property 'forge.enabledGameTestNamespaces', mod_id
+        register('server') {
+            systemProperty 'forge.enabledGameTestNamespaces', mod_id
             args '--nogui'
         }
 
-        // This run config launches GameTestServer and runs all registered gametests, then exits.
-        // By default, the server will crash when no gametests are provided.
-        // The gametest system is also enabled by default for other run configs under the /test command.
-        gameTestServer {
-            property 'forge.enabledGameTestNamespaces', mod_id
+        register('gameTestServer') {
+            systemProperty 'forge.enabledGameTestNamespaces', mod_id
         }
 
-        data {
-            // example of overriding the workingDirectory set in configureEach above
-            workingDirectory project.file('run-data')
+        register('data') {
+            workingDir = layout.projectDirectory.dir('run-data')
 
-            // Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources.
-            args '--mod', mod_id, '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/')
+            args '--mod', mod_id, '--all', '--output', layout.projectDirectory.dir('src/generated/resources'), '--existing', layout.projectDirectory.dir('src/main/resources')
         }
     }
 }
 
-// Include resources generated by data generators.
-sourceSets.main.resources { srcDir 'src/generated/resources' }
-
 repositories {
-    // Put repositories for dependencies here
-    // ForgeGradle automatically adds the Forge maven and Maven Central for you
-
-    // If you have mod jar dependencies in ./libs, you can declare them as a repository like so.
-    // See https://docs.gradle.org/current/userguide/declaring_repositories.html#sub:flat_dir_resolver
-    // flatDir {
-    //     dir 'libs'
-    // }
+    minecraft.mavenizer(it)
+    maven fg.forgeMaven
+    maven fg.minecraftLibsMaven
+    // Needed for JEI
+    // maven { url = 'https://maven.blamejared.com/' }
 }
 
 dependencies {
-    // Specify the version of Minecraft to use.
-    // Any artifact can be supplied so long as it has a "userdev" classifier artifact and is a compatible patcher artifact.
-    // The "userdev" classifier will be requested and setup by ForgeGradle.
-    // If the group id is "net.minecraft" and the artifact id is one of ["client", "server", "joined"],
-    // then special handling is done to allow a setup of a vanilla dependency without the use of an external repository.
-    minecraft "net.minecraftforge:forge:${minecraft_version}-${forge_version}"
-
-    // Example mod dependency with JEI - using fg.deobf() ensures the dependency is remapped to your development mappings
-    // The JEI API is declared for compile time use, while the full JEI artifact is used at runtime
-    // compileOnly fg.deobf("mezz.jei:jei-${mc_version}-common-api:${jei_version}")
-    // compileOnly fg.deobf("mezz.jei:jei-${mc_version}-forge-api:${jei_version}")
-    // runtimeOnly fg.deobf("mezz.jei:jei-${mc_version}-forge:${jei_version}")
-
-    // Example mod dependency using a mod jar from ./libs with a flat dir repository
-    // This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar
-    // The group id is ignored when searching -- in this case, it is "blank"
-    // implementation fg.deobf("blank:coolmod-${mc_version}:${coolmod_version}")
-
-    // For more info:
-    // http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
-    // http://www.gradle.org/docs/current/userguide/dependency_management.html
+    // Minecraft/Forge itself
+    implementation minecraft.dependency("net.minecraftforge:forge:$minecraft_version-$forge_version")
+    // A 3rd party mod, which needs to be deobfuscated from SRG names to the mappings we're using
+    // implementation renamer.dependency('mezz.jei:jei-1.20.1-forge:15.20.0.129')
+    // annotationProcessor 'org.spongepowered:mixin:0.8.7:processor'
 }
 
 // This block of code expands all declared replace properties in the specified resource targets.
 // A missing property will result in an error. Properties are expanded using ${} Groovy notation.
 // When "copyIdeResources" is enabled, this will also run before the game launches in IDE environments.
 // See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
-tasks.named('processResources', ProcessResources).configure {
+tasks.named('processResources', ProcessResources) {
     var replaceProperties = [
             minecraft_version: minecraft_version, minecraft_version_range: minecraft_version_range,
             forge_version: forge_version, forge_version_range: forge_version_range,
@@ -158,15 +89,15 @@ tasks.named('processResources', ProcessResources).configure {
             mod_id: mod_id, mod_name: mod_name, mod_license: mod_license, mod_version: mod_version,
             mod_authors: mod_authors, mod_description: mod_description,
     ]
-    inputs.properties replaceProperties
+    inputs.property('replaceProperties', replaceProperties)
 
     filesMatching(['META-INF/mods.toml', 'pack.mcmeta']) {
-        expand replaceProperties + [project: project]
+        expand replaceProperties
     }
 }
 
 // Example for how to get properties into the manifest for reading at runtime.
-tasks.named('jar', Jar).configure {
+tasks.named('jar', Jar) {
     manifest {
         attributes([
                 'Specification-Title'     : mod_id,
@@ -174,34 +105,64 @@ tasks.named('jar', Jar).configure {
                 'Specification-Version'   : '1', // We are version 1 of ourselves
                 'Implementation-Title'    : project.name,
                 'Implementation-Version'  : project.jar.archiveVersion,
-                'Implementation-Vendor'   : mod_authors,
-                'Implementation-Timestamp': new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
+                'Implementation-Vendor'   : mod_authors
         ])
+        //attributes['MixinConfigs'] = "${mod_id}.mixins.json"
     }
-
-    // This is the preferred method to reobfuscate your jar file
-    finalizedBy 'reobfJar'
+    // This artifact will not be renamed. While this will not launch in production
+    // the artifact may be helpful for other developers if your mod is used as a library.
+    // By assigning this archive classifier, jar file name will end in '-unobfuscated'
+    // e.g. 'examplemod-1.0-unobfuscated.jar'
+    archiveClassifier = 'unobfuscated'
 }
 
-// However if you are in a multi-project build, dev time needs unobfed jar files, so you can delay the obfuscation until publishing by doing:
-// tasks.named('publish').configure {
-//     dependsOn 'reobfJar'
-// }
+// Set the default mappings file to our default minecraft dependency
+// This must be done after `minecraft.dependency('coords')` has been done so that gradle knows what dependency we want
+// This mapping will be used by default for all renamer tasks, including deobfuscating dependencies
+// You can still override each specific task, this is just to save repeating yourself in your buildscript.
+renamer.mappings.from minecraft.dependency.toSrgFile
+
+// If you are choosing to use mixins, you must give Renamer the additional information for it to handle the refmaps.
+//renamer.enableMixinRefmaps {
+//    config "${mod_id}.mixins.json"
+//    refMap "${mod_id}.refmap.json"
+//}
+
+// Creates a task named 'renameJar'
+renamer.classes(tasks.named('jar', Jar)) {
+    // This artifact will be remapped according to the provided mappings file
+    // Setting the classifier to '' will attach no extra details to the file name.
+    // e.g. 'examplemod-1.0.jar'
+    archiveClassifier = ''
+    // Unless set globally like above, You need to point to the mappings you wish to apply, typically this is
+    // the Mapped names to SRG for older versions.
+    // ForgeGradle/Mavenizer generate these files for the dependencies you declare. So you can use the helper.
+    // Or you can specify the file or dependency if you host them yourself.
+    // map.from minecraft.dependency.toSrgFile
+
+    // The mixin AP does not include all annotated entries, instead containing some in the augmented mappings.
+    // So, if you are using mixins or have dependencies which use them, uncomment the below line to tell renamer
+    // that the generated mappings are available. See the MDKExample for more details.
+    // mappings renamer.mixin.generatedMappings
+}
 
 // Example configuration to allow publishing using the maven-publish plugin
+// We recommend publishing all of your artifacts to publicly accessible maven so that others can easily consume them as dependencies
 publishing {
-    publications {
-        register('mavenJava', MavenPublication) {
-            artifact jar
-        }
-    }
     repositories {
-        maven {
-            url "file://${project.projectDir}/mcmodsrepo"
-        }
+        // Publishing to a local folder makes it easy to see exactly what you would publish to a real server
+        maven { url = layout.projectDirectory.dir('repo').asFile.toURI() }
+    }
+
+    publications.register('mavenJava', MavenPublication) {
+        from components.java // Publish the normal jar
+        artifact renameJar // Publish the renamed jar in addition
     }
 }
 
 tasks.withType(JavaCompile).configureEach {
     options.encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation
 }
+
+// IntelliJ no longer downloads javadocs and sources by default, this tells Gradle to force IntelliJ to do it.
+idea.module { downloadJavadoc = downloadSources = true }

mdk/gradle.properties

@@ -1,25 +1,29 @@
-# Sets default memory used for gradle commands. Can be overridden by user or command line properties.
-# This is required to provide enough memory for the Minecraft decompilation process.
-org.gradle.jvmargs=-Xmx3G
-org.gradle.daemon=false
+org.gradle.caching=true
+org.gradle.parallel=true
+org.gradle.configureondemand=true
 
+org.gradle.configuration-cache=true
+org.gradle.configuration-cache.parallel=true
+org.gradle.configuration-cache.problems=warn
+
+net.minecraftforge.gradle.merge-source-sets=true
 
 ## Environment Properties
 
 # The Minecraft version must agree with the Forge version to get a valid artifact
-minecraft_version=@MC_VERSION@
+minecraft_version=1.20.1
 # The Minecraft version range can use any release version of Minecraft as bounds.
 # Snapshots, pre-releases, and release candidates are not guaranteed to sort properly
 # as they do not follow standard versioning conventions.
-minecraft_version_range=[@MC_VERSION@,@MC_NEXT_VERSION@)
+minecraft_version_range=[1.20.1, 1.20.2)
 # The Forge version must agree with the Minecraft version to get a valid artifact
 forge_version=@FORGE_VERSION@
 # The Forge version range can use any version of Forge as bounds or match the loader version range
-forge_version_range=[@FORGE_SPEC_VERSION@,)
+forge_version_range=[47,)
 # The loader version range can only use the major version of Forge/FML as bounds
-loader_version_range=[@FORGE_SPEC_VERSION@,)
+loader_version_range=[47,)
 # The mapping channel to use for mappings.
-# The default set of supported mapping channels are ["official", "snapshot", "snapshot_nodoc", "stable", "stable_nodoc"].
+# The default set of supported mapping channels are ["official", "parchment"].
 # Additional mapping channels can be registered through the "channelProviders" extension in a Gradle plugin.
 #
 # | Channel   | Version              |                                                                                |
@@ -31,12 +35,11 @@ loader_version_range=[@FORGE_SPEC_VERSION@,)
 # See more information here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
 #
 # Parchment is an unofficial project maintained by ParchmentMC, separate from Minecraft Forge.
-# Additional setup is needed to use their mappings, see https://parchmentmc.org/docs/getting-started
-mapping_channel=@MAPPING_CHANNEL@
+# Unlike in FG6, Parchment no longer requires the Librarian plugin to be set up.
+mapping_channel=official
 # The mapping version to query from the mapping channel.
 # This must match the format required by the mapping channel.
-mapping_version=@MAPPING_VERSION@
-
+mapping_version=1.20.1
 
 ## Mod Properties
 

mdk/settings.gradle

@@ -1,13 +1,5 @@
-pluginManagement {
-    repositories {
-        gradlePluginPortal()
-        maven {
-            name = 'MinecraftForge'
-            url = 'https://maven.minecraftforge.net/'
-        }
-    }
+plugins {
+    id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0'
 }
 
-plugins {
-    id 'org.gradle.toolchains.foojay-resolver-convention' version '0.7.0'
-}
+rootProject.name = 'examplemod'