Refactor: Build scripts

Author: emyfops

build.gradle.kts

@@ -1,29 +1,27 @@
-import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import net.fabricmc.loom.api.LoomGradleExtensionAPI
-import net.fabricmc.loom.task.RemapJarTask
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import java.util.*
 
-val targets = listOf("META-INF/*.toml", "fabric.mod.json")
-val replacements = file("gradle.properties").inputStream().use { stream ->
-    Properties().apply { load(stream) }
-}.map { (k, v) -> k.toString() to v.toString() }.toMap()
-
 val modId: String by project
 val modVersion: String by project
 val mavenGroup: String by project
 val minecraftVersion: String by project
 val yarnMappings: String by project
 
 val libs = file("libs")
+val targets = listOf("META-INF/*.toml", "fabric.mod.json")
+val replacements = file("gradle.properties").inputStream().use { stream ->
+    Properties().apply { load(stream) }
+}.map { (k, v) -> k.toString() to v.toString() }.toMap()
+
 val Project.loom: LoomGradleExtensionAPI
     get() = (this as ExtensionAware).extensions.getByName("loom") as LoomGradleExtensionAPI
 
 plugins {
     kotlin("jvm") version "2.0.0"
     id("org.jetbrains.dokka") version "1.9.20"
     id("architectury-plugin") version "3.4-SNAPSHOT"
-    id("dev.architectury.loom") version "1.6-SNAPSHOT" apply false
+    id("dev.architectury.loom") version "1.7-SNAPSHOT" apply false
     id("com.github.johnrengelman.shadow") version "8.1.1" apply false
 }
 
@@ -42,33 +40,7 @@ subprojects {
 
     if (path == ":common") return@subprojects
 
-    apply(plugin = "com.github.johnrengelman.shadow")
-
-    val versionWithMCVersion = "$modVersion+$minecraftVersion"
-
     tasks {
-        val shadowCommon by configurations.creating {
-            isCanBeConsumed = false
-            isCanBeResolved = true
-        }
-
-        val shadow = named<ShadowJar>("shadowJar") {
-            archiveVersion = versionWithMCVersion
-            archiveClassifier.set("shadow")
-            configurations = listOf(shadowCommon)
-        }
-
-        named<RemapJarTask>("remapJar") {
-            dependsOn(shadow)
-            inputFile = shadow.flatMap { it.archiveFile }
-            archiveVersion = versionWithMCVersion
-            archiveClassifier = ""
-        }
-
-        jar {
-            enabled = false
-        }
-
         processResources {
             // Replaces placeholders in the mod info files
             filesMatching(targets) {

fabric/build.gradle.kts

@@ -1,10 +1,15 @@
+val modVersion: String by project
 val minecraftVersion: String by project
 val fabricLoaderVersion: String by project
 val fabricApiVersion: String by project
 val kotlinFabricVersion: String by project
 
 base.archivesName = "${base.archivesName.get()}-fabric"
 
+plugins {
+    id("com.github.johnrengelman.shadow") version "8.1.1"
+}
+
 architectury {
     platformSetupLoomIde()
     fabric()
@@ -40,11 +45,6 @@ fun DependencyHandlerScope.setupConfigurations() {
         modImplementation(it)
         include(it)
     }
-
-    shadowBundle.dependencies.forEach {
-        shadowCommon(it)
-        shadow(it)
-    }
 }
 
 dependencies {
@@ -73,10 +73,19 @@ dependencies {
 }
 
 tasks {
-    // Access wideners are the successor of the mixins accessor
-    // that were used in the past to access private fields and methods.
-    // They allow you to make field, method, and class access public.
+    shadowJar {
+        archiveVersion = "$modVersion+$minecraftVersion"
+        configurations = listOf(shadowBundle)
+        archiveClassifier = "dev-shadow"
+    }
+
     remapJar {
+        dependsOn(shadowJar)
+        inputFile = shadowJar.get().archiveFile
+
+        // Access wideners are the successor of the mixins accessor
+        // that were used in the past to access private fields and methods.
+        // They allow you to make field, method, and class access public.
         injectAccessWidener = true
     }
 }

forge/build.gradle.kts

@@ -1,10 +1,15 @@
+val modVersion: String by project
 val minecraftVersion: String by project
 val forgeVersion: String by project
 val mixinExtrasVersion: String by project
 val kotlinForgeVersion: String by project
 
 base.archivesName = "${base.archivesName.get()}-forge"
 
+plugins {
+    id("com.github.johnrengelman.shadow") version "8.1.1"
+}
+
 architectury {
     platformSetupLoomIde()
     forge()
@@ -62,11 +67,6 @@ fun DependencyHandlerScope.setupConfigurations() {
         forgeRuntimeLibrary(it)
         include(it)
     }
-
-    shadowBundle.dependencies.forEach {
-        shadowCommon(it)
-        shadow(it)
-    }
 }
 
 dependencies {
@@ -81,13 +81,13 @@ dependencies {
     includeMod("thedarkcolour:kotlinforforge:$kotlinForgeVersion")
     includeMod("baritone-api:baritone-unoptimized-forge:1.10.2")
 
+    // Fix KFF
+    compileOnly(kotlin("stdlib"))
+
     // MixinExtras
     implementation("io.github.llamalad7:mixinextras-forge:$mixinExtrasVersion")
     compileOnly(annotationProcessor("io.github.llamalad7:mixinextras-common:$mixinExtrasVersion")!!)
 
-    // Fix KFF
-    compileOnly(kotlin("stdlib"))
-
     // Disable reflections logging
     include("org.slf4j:slf4j-nop:2.0.13")
 
@@ -100,9 +100,24 @@ dependencies {
 }
 
 tasks {
+    // Merge the resources and classes into the same directory.
+    // This is done because java expects modules to be in a single directory.
+    // And if we have it in multiple we have to do performance intensive hacks like having the UnionFileSystem
+    // This will eventually be migrated to ForgeGradle so modders don't need to manually do it. But that is later.
     sourceSets.forEach {
         val dir = layout.buildDirectory.dir("sourcesSets/${it.name}")
         it.output.setResourcesDir(dir)
         it.java.destinationDirectory.set(dir)
     }
+
+    shadowJar {
+        archiveVersion = "$modVersion+$minecraftVersion"
+        configurations = listOf(shadowBundle)
+        archiveClassifier = "dev-shadow"
+    }
+
+    remapJar {
+        dependsOn(processResources, shadowJar)
+        inputFile = shadowJar.get().archiveFile
+    }
 }

neoforge/build.gradle.kts

@@ -1,8 +1,14 @@
+val modVersion: String by project
+val minecraftVersion: String by project
 val neoVersion: String by project
 val kotlinForgeVersion: String by project
 
 base.archivesName = "${base.archivesName.get()}-neoforge"
 
+plugins {
+    id("com.github.johnrengelman.shadow") version "8.1.1"
+}
+
 architectury {
     platformSetupLoomIde()
     neoForge()
@@ -42,11 +48,6 @@ fun DependencyHandlerScope.setupConfigurations() {
         implementation(it)
         include(it)
     }
-
-    shadowBundle.dependencies.forEach {
-        shadowCommon(it)
-        shadow(it)
-    }
 }
 
 dependencies {
@@ -79,8 +80,14 @@ tasks {
         }
     }
 
+    shadowJar {
+        archiveVersion = "$modVersion+$minecraftVersion"
+        configurations = listOf(shadowBundle)
+        archiveClassifier = "dev-shadow"
+    }
+
     remapJar {
-        dependsOn(processResources)
-        atAccessWideners.add("lambda.accesswidener") // Add the access widener to the remapper
+        dependsOn(processResources, shadowJar)
+        inputFile = shadowJar.get().archiveFile
     }
 }