Bring up to speed with the OneConfig example mod

Polyfrost · Jan 2, 2025 · 918de78 · 918de78
1 parent 7b0e1f8
commit 918de78
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 86 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,32 +1,47 @@
-name: build
+# Build Workflow
+
+name: Build with Gradle
 
 on:
-  push:
   pull_request:
+  workflow_dispatch:
+  push:
+
+concurrency:
+  group: ${{ github.head_ref || format('{0}-{1}', github.ref, github.run_number) }}
+  cancel-in-progress: true
 
 jobs:
   build:
-    name: "Build"
-    runs-on: "ubuntu-latest"
+    name: Build
 
-    steps:
-      - uses: actions/checkout@v4
+    runs-on: ubuntu-latest
 
-      - uses: gradle/wrapper-validation-action@v3
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 10
 
-      - uses: actions/setup-java@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
         with:
-          distribution: "temurin"
-          java-version: "21"
+          java-version: 21
+          distribution: temurin
 
       - uses: actions/cache@v4
         with:
           path: |
             ~/.gradle/caches
             ~/.gradle/wrapper
             **/loom-cache
-          key: ${{ runner.os }}-gradle-v2-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+            **/prebundled-jars
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
           restore-keys: |
-            ${{ runner.os }}-gradle-v2-
+            ${{ runner.os }}-gradle-
+
+      - name: Chmod Gradle
+        run: chmod +x ./gradlew
 
-      - run: ./gradlew --no-daemon build
+      - name: Build
+        run: ./gradlew build --no-daemon
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,70 +1,52 @@
 @file:Suppress("UnstableApiUsage", "PropertyName")
 
 import dev.deftu.gradle.utils.GameSide
+import dev.deftu.gradle.utils.MinecraftVersion
 
 plugins {
     java
     kotlin("jvm")
-    id("dev.deftu.gradle.multiversion")
-    id("dev.deftu.gradle.tools")
-    id("dev.deftu.gradle.tools.resources")
-    id("dev.deftu.gradle.tools.bloom")
-    id("dev.deftu.gradle.tools.shadow")
-    id("dev.deftu.gradle.tools.minecraft.loom")
+    id("dev.deftu.gradle.multiversion") // Applies preprocessing for multiple versions of Minecraft and/or multiple mod loaders.
+    id("dev.deftu.gradle.tools") // Applies several configurations to things such as the Java version, project name/version, etc.
+    id("dev.deftu.gradle.tools.resources") // Applies resource processing so that we can replace tokens, such as our mod name/version, in our resources.
+    id("dev.deftu.gradle.tools.bloom") // Applies the Bloom plugin, which allows us to replace tokens in our source files, such as being able to use `@MOD_VERSION` in our source files.
+    id("dev.deftu.gradle.tools.shadow") // Applies the Shadow plugin, which allows us to shade our dependencies into our mod JAR. This is NOT recommended for Fabric mods, but we have an *additional* configuration for those!
+    id("dev.deftu.gradle.tools.ducks") // Creates a ducks source set, which allows us to use theoretical classes which may not exist at runtime (such as things which are in other mods).
+    id("dev.deftu.gradle.tools.minecraft.loom") // Applies the Loom plugin, which automagically configures Essential's Architectury Loom plugin for you.
+    id("dev.deftu.gradle.tools.minecraft.releases") // Applies the Minecraft auto-releasing plugin, which allows you to automatically release your mod to CurseForge and Modrinth.
 }
 
-val accessTransformerName = "patcher1${mcData.version.minor}_at.cfg"
+toolkitLoomHelper {
+    useOneConfig {
+        version = "1.0.0-alpha.49"
+        loaderVersion = "1.1.0-alpha.35"
 
-// Sets up the variables for when we preprocess to other Minecraft versions.
-preprocess {
-    vars.put("MODERN", if (mcData.version.minor >= 16) 1 else 0)
-}
+        usePolyMixin = true
+        polyMixinVersion = "0.8.4+build.2"
 
-//if (project.platform.isLegacyForge) {
-//    runConfigs {
-//        "client" {
-//            property("patcher.debugBytecode", "true")
-//            property("mixin.debug.verbose", "true")
-//            property("mixin.debug.export", "true")
-//            property("mixin.dumpTargetOnFailure", "true")
-//            property("fml.coreMods.load", "club.sk1er.patcher.tweaker.PatcherTweaker")
-//            programArgs("--tweakClass", "org.polyfrost.oneconfig.internal.legacy.OneConfigTweaker")
-//            programArgs("--tweakClass", "org.spongepowered.asm.launch.MixinTweaker")
-//            property("mixin.debug.export", "true")
-//            programArgs("--mixin", "mixins.${mod_id}.json")
-//        }
-//    }
-//}
-
-//if (project.platform.isForge) {
-//    forge {
-//        accessTransformer(rootProject.file("src/main/resources/$accessTransformerName"))
-//        mixinConfig("mixins.${mod_id}.json")
-//    }
-//}
+        applyLoaderTweaker = true
 
-toolkitLoomHelper {
-    useOneConfig("1.1.0-alpha.34", "1.0.0-alpha.43", mcData, "commands", "config-impl", "events", "hud", "internal", "ui")
-    useDevAuth()
+        for (module in arrayOf("commands", "config", "config-impl", "events", "internal", "ui", "utils")) {
+            +module
+        }
+    }
 
+    // Turns off the server-side run configs, as we're building a client-sided mod.
     disableRunConfigs(GameSide.SERVER)
 
+    // Defines the name of the Mixin refmap, which is used to map the Mixin classes to the obfuscated Minecraft classes.
     if (!mcData.isNeoForge) {
         useMixinRefMap(modData.id)
     }
 
-    if (mcData.isLegacyForge) {
-        useTweaker("org.polyfrost.oneconfig.loader.stage0.LaunchWrapperTweaker", GameSide.CLIENT)
-        useForgeMixin(modData.id) // Configures the mixins if we are building for forge, useful for when we are dealing with cross-platform projects.
-
-        useProperty("patcher.debugBytecode", "true", GameSide.CLIENT)
-        useProperty("mixin.debug.verbose", "true", GameSide.CLIENT)
-        useProperty("mixin.debug.export", "true", GameSide.CLIENT)
-        useProperty("mixin.dumpTargetOnFailure", "true", GameSide.CLIENT)
-        useProperty("fml.coreMods.load", "club.sk1er.patcher.tweaker.PatcherTweaker", GameSide.CLIENT)
+    if (mcData.isForge) {
+        // Configures the Mixin tweaker if we are building for Forge.
+        useForgeMixin(modData.id)
     }
 }
 
+val accessTransformerName = "patcher1${mcData.version.minor}_at.cfg"
+
 if (mcData.isForge) {
     loom {
         forge {
@@ -73,16 +55,6 @@ if (mcData.isForge) {
     }
 }
 
-// Configures the output directory for when building from the `src/resources` directory.
-sourceSets {
-    val dummy by creating
-    main {
-        dummy.compileClasspath += compileClasspath
-        compileClasspath += dummy.output
-        output.setResourcesDir(java.classesDirectory)
-    }
-}
-
 // Configures the libraries/dependencies for your mod.
 dependencies {
     modImplementation(shade("org.polyfrost:elementa-$mcData:562") {
@@ -99,13 +71,15 @@ dependencies {
         implementation(shade("it.unimi.dsi:fastutil:8.5.13")!!)
     }
 
-    // If we are building for legacy forge, includes the launch wrapper with `shade` as we configured earlier.
-    if (mcData.isLegacyForge) {
-        compileOnly("org.polyfrost:polymixin:0.8.4+build.2")
-        //todo fix with V1
-        //modImplementation("org.polyfrost:legacy-crafty-crashes:1.0.0") {
-        //    isTransitive = false
-        //}
+    // Add Fabric Language Kotlin and (Legacy) Fabric API as dependencies (these are both optional but are particularly useful).
+    if (mcData.isFabric) {
+        if (mcData.isLegacyFabric) {
+            // 1.8.9 - 1.13
+            modImplementation("net.legacyfabric.legacy-fabric-api:legacy-fabric-api:${mcData.dependencies.legacyFabric.legacyFabricApiVersion}")
+        } else {
+            // 1.16.5+
+            modImplementation("net.fabricmc.fabric-api:fabric-api:${mcData.dependencies.fabric.fabricApiVersion}")
+        }
     }
 }
 

diff --git a/root.gradle.kts b/root.gradle.kts
@@ -3,12 +3,20 @@ plugins {
 }
 
 preprocess {
-    strictExtraMappings.set(true)
-    "1.12.2-forge"(11202, "srg") {
-        "1.12.2-fabric"(11202, "yarn") {
-            "1.8.9-fabric"(10809, "yarn", file("versions/1.12.2-1.8.9.txt")) {
-                "1.8.9-forge"(10809, "srg")
+    // Adding new versions/loaders can be done like so:
+    // For each version, we add a new wrapper around the last from highest to lowest.
+    // Each mod loader needs to link up to the previous version's mod loader so that the mappings can be processed from the previous version.
+    // "1.12.2-forge"(11202, "srg") {
+    //     "1.8.9-forge"(10809, "srg")
+    // }
+
+    "1.12.2-fabric"(11202, "yarn") {
+        "1.12.2-forge"(11202, "srg") {
+            "1.8.9-forge"(10809, "srg", file("versions/1.12.2-1.8.9.txt")) {
+                "1.8.9-fabric"(10809, "yarn")
             }
         }
     }
-}
+
+    strictExtraMappings.set(true)
+}
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,8 +1,10 @@
+@file:Suppress("PropertyName")
+
 import groovy.lang.MissingPropertyException
 
 pluginManagement {
     repositories {
-        // Repositories
+        // Releases
         maven("https://maven.deftu.dev/releases")
         maven("https://maven.fabricmc.net")
         maven("https://maven.architectury.dev/")
@@ -15,32 +17,37 @@ pluginManagement {
         maven("https://maven.deftu.dev/snapshots")
         mavenLocal()
 
-        // Default repositories
+        // Default
         gradlePluginPortal()
         mavenCentral()
     }
 
     plugins {
         kotlin("jvm") version("2.0.0")
-        id("dev.deftu.gradle.multiversion-root") version("2.13.0")
+        id("dev.deftu.gradle.multiversion-root") version("2.18.1")
     }
 }
 
 val projectName: String = extra["mod.name"]?.toString()
     ?: throw MissingPropertyException("mod.name has not been set.")
+
+// Configures the root project Gradle name based on the value in `gradle.properties`
 rootProject.name = projectName
 rootProject.buildFileName = "root.gradle.kts"
 
 // Adds all of our build target versions to the classpath if we need to add version-specific code.
+// Update this list if you want to remove/add a version and/or mod loader.
+// The format is: version-modloader (f.ex: 1.8.9-forge, 1.17.1-fabric, etc)
+// **REMEMBER TO ALSO UPDATE THE `root.gradle.kts` AND `build.gradle.kts` FILES WITH THE NEW VERSION(S).
 listOf(
     "1.8.9-forge",
     "1.8.9-fabric",
+    "1.12.2-fabric",
     "1.12.2-forge",
-    "1.12.2-fabric"
 ).forEach { version ->
     include(":$version")
     project(":$version").apply {
         projectDir = file("versions/$version")
         buildFileName = "../../build.gradle.kts"
     }
-}
+}