Full rewrite, V1 port and Legacy Fabric port

Author: Deftu

build.gradle.kts

@@ -1,194 +1,59 @@
 @file:Suppress("UnstableApiUsage", "PropertyName")
 
-import org.polyfrost.gradle.util.noServerRunConfigs
-import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+import dev.deftu.gradle.utils.GameSide
 
-// Adds support for kotlin, and adds the Polyfrost Gradle Toolkit
-// which we use to prepare the environment.
 plugins {
-    kotlin("jvm")
-    id("org.polyfrost.multi-version")
-    id("org.polyfrost.defaults.repo")
-    id("org.polyfrost.defaults.java")
-    id("org.polyfrost.defaults.loom")
-    id("com.github.johnrengelman.shadow")
-    id("net.kyori.blossom") version "1.3.1"
-    id("signing")
     java
+    kotlin("jvm")
+    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.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.
 }
 
-// Gets the mod name, version and id from the `gradle.properties` file.
-val mod_name: String by project
-val mod_version: String by project
-val mod_id: String by project
-val mod_archives_name: String by project
-
-// Sets up the variables for when we preprocess to other Minecraft versions.
-preprocess {
-    vars.put("MODERN", if (project.platform.mcMinor >= 16) 1 else 0)
-}
-
-// Replaces the variables in `ExampleMod.java` to the ones specified in `gradle.properties`.
-blossom {
-    replaceToken("@VER@", mod_version)
-    replaceToken("@NAME@", mod_name)
-    replaceToken("@ID@", mod_id)
-}
-
-// Sets the mod version to the one specified in `gradle.properties`. Make sure to change this following semver!
-version = mod_version
-// Sets the group, make sure to change this to your own. It can be a website you own backwards or your GitHub username.
-// e.g. com.github.<your username> or com.<your domain>
-group = "org.polyfrost"
+toolkitLoomHelper {
+    useOneConfig {
+        version = "1.0.0-alpha.55"
+        loaderVersion = "1.1.0-alpha.35"
 
-// Sets the name of the output jar (the one you put in your mods folder and send to other people)
-// It outputs all versions of the mod into the `build` directory.
-base {
-    archivesName.set("$mod_archives_name-$platform")
-}
+        usePolyMixin = true
+        polyMixinVersion = "0.8.4+build.2"
 
-// Configures the Polyfrost Loom, our plugin fork to easily set up the programming environment.
-loom {
-    // Removes the server configs from IntelliJ IDEA, leaving only client runs.
-    // If you're developing a server-side mod, you can remove this line.
-    noServerRunConfigs()
+        applyLoaderTweaker = true
 
-    // Adds the tweak class if we are building legacy version of forge as per the documentation (https://docs.polyfrost.org)
-    if (project.platform.isLegacyForge) {
-        runConfigs {
-            "client" {
-                programArgs("--tweakClass", "cc.polyfrost.oneconfig.loader.stage0.LaunchWrapperTweaker")
-                property("mixin.debug.export", "true")
-            }
+        for (module in arrayOf("commands", "config", "config-impl", "events", "internal", "ui", "utils")) {
+            +module
         }
     }
-    // Configures the mixins if we are building for forge, useful for when we are dealing with cross-platform projects.
-    if (project.platform.isForge) {
-        forge {
-            mixinConfig("mixins.${mod_id}.json")
-        }
-    }
-    // Configures the name of the mixin "refmap" using an experimental loom api.
-    mixin.defaultRefmapName.set("mixins.${mod_id}.refmap.json")
-}
+    useDevAuth("1.2.1")
+    useMixinExtras("0.4.1")
 
-// Creates the shade/shadow configuration, so we can include libraries inside our mod, rather than having to add them separately.
-val shade: Configuration by configurations.creating {
-    configurations.implementation.get().extendsFrom(this)
-}
+    // Turns off the server-side run configs, as we're building a client-sided mod.
+    disableRunConfigs(GameSide.SERVER)
 
-// Configures the output directory for when building from the `src/resources` directory.
-sourceSets {
-    main {
-        output.setResourcesDir(java.classesDirectory)
+    // 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)
     }
-}
-
-// Adds the Polyfrost maven repository so that we can get the libraries necessary to develop the mod.
-repositories {
-    maven("https://repo.polyfrost.org/releases")
-}
-
-// Configures the libraries/dependencies for your mod.
-dependencies {
-    // Adds the OneConfig library, so we can develop with it.
-    modCompileOnly("cc.polyfrost:oneconfig-$platform:0.2.1-alpha+")
-
-    modRuntimeOnly("me.djtheredstoner:DevAuth-${if (platform.isFabric) "fabric" else if (platform.isLegacyForge) "forge-legacy" else "forge-latest"}:1.1.2")
 
-    // If we are building for legacy forge, includes the launch wrapper with `shade` as we configured earlier.
-    if (platform.isLegacyForge) {
-        compileOnly("org.spongepowered:mixin:0.7.11-SNAPSHOT")
-        shade("cc.polyfrost:oneconfig-wrapper-launchwrapper:1.0.0-beta+")
+    if (mcData.isForge) {
+        // Configures the Mixin tweaker if we are building for Forge.
+        useForgeMixin(modData.id)
     }
 }
 
-tasks {
-    // Processes the `src/resources/mcmod.info or fabric.mod.json` and replaces
-    // the mod id, name and version with the ones in `gradle.properties`
-    processResources {
-        inputs.property("id", mod_id)
-        inputs.property("name", mod_name)
-        val java = if (project.platform.mcMinor >= 18) {
-            17 // If we are playing on version 1.18, set the java version to 17
-        } else {
-            // Else if we are playing on version 1.17, use java 16.
-            if (project.platform.mcMinor == 17)
-                16
-            else
-                8 // For all previous versions, we **need** java 8 (for Forge support).
-        }
-        val compatLevel = "JAVA_${java}"
-        inputs.property("java", java)
-        inputs.property("java_level", compatLevel)
-        inputs.property("version", mod_version)
-        inputs.property("mcVersionStr", project.platform.mcVersionStr)
-        filesMatching(listOf("mcmod.info", "mixins.${mod_id}.json", "mods.toml")) {
-            expand(
-                mapOf(
-                    "id" to mod_id,
-                    "name" to mod_name,
-                    "java" to java,
-                    "java_level" to compatLevel,
-                    "version" to mod_version,
-                    "mcVersionStr" to project.platform.mcVersionStr
-                )
-            )
-        }
-        filesMatching("fabric.mod.json") {
-            expand(
-                mapOf(
-                    "id" to mod_id,
-                    "name" to mod_name,
-                    "java" to java,
-                    "java_level" to compatLevel,
-                    "version" to mod_version,
-                    "mcVersionStr" to project.platform.mcVersionStr.substringBeforeLast(".") + ".x"
-                )
-            )
-        }
-    }
-
-    // Configures the resources to include if we are building for forge or fabric.
-    withType(Jar::class.java) {
-        if (project.platform.isFabric) {
-            exclude("mcmod.info", "mods.toml")
+dependencies {
+    // Add (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 {
-            exclude("fabric.mod.json")
-            if (project.platform.isLegacyForge) {
-                exclude("mods.toml")
-            } else {
-                exclude("mcmod.info")
-            }
-        }
-    }
-
-    // Configures our shadow/shade configuration, so we can
-    // include some dependencies within our mod jar file.
-    named<ShadowJar>("shadowJar") {
-        archiveClassifier.set("dev") // TODO: machete gets confused by the `dev` prefix.
-        configurations = listOf(shade)
-        duplicatesStrategy = DuplicatesStrategy.EXCLUDE
-    }
-
-    remapJar {
-        inputFile.set(shadowJar.get().archiveFile)
-        archiveClassifier.set("")
-    }
-
-    jar {
-        // Sets the jar manifest attributes.
-        if (platform.isLegacyForge) {
-            manifest.attributes += mapOf(
-                "ModSide" to "CLIENT", // We aren't developing a server-side mod, so this is fine.
-                "ForceLoadAsMod" to true, // We want to load this jar as a mod, so we force Forge to do so.
-                "TweakOrder" to "0", // Makes sure that the OneConfig launch wrapper is loaded as soon as possible.
-                "MixinConfigs" to "mixins.${mod_id}.json", // We want to use our mixin configuration, so we specify it here.
-                "TweakClass" to "cc.polyfrost.oneconfig.loader.stage0.LaunchWrapperTweaker" // Loads the OneConfig launch wrapper.
-            )
+            // 1.16.5+
+            modImplementation("net.fabricmc.fabric-api:fabric-api:${mcData.dependencies.fabric.fabricApiVersion}")
         }
-        dependsOn(shadowJar)
-        archiveClassifier.set("")
-        enabled = false
     }
 }

gradle.properties

@@ -1,12 +1,18 @@
-mod_name = PolyWeather
-mod_id = polyweather
-mod_version = 1.0.0
-mod_archives_name=PolyWeather
-
 # Gradle Configuration -- DO NOT TOUCH THESE VALUES.
 polyfrost.defaults.loom=1
 org.gradle.daemon=true
 org.gradle.parallel=true
 org.gradle.configureoncommand=true
 org.gradle.parallel.threads=4
-org.gradle.jvmargs=-Xmx2G
+org.gradle.jvmargs=-Xmx2G
+
+# gradle.properties file -- CHANGE THE VALUES STARTING WITH `mod.*` AND REMOVE THIS COMMENT.
+
+# Sets the name of your mod.
+mod.name=PolyWeather
+# Sets the ID of your mod that mod loaders use to recognize it.
+mod.id=polyweather
+# Sets the version of your mod. Make sure to update this when you make changes according to the SemVer specification.
+mod.version=1.0.0
+# Sets the Maven group ID of your mod. This is effectively unused but is good practice to set regardless.
+mod.group=org.polyfrost

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

root.gradle.kts

@@ -1,11 +1,22 @@
 plugins {
-    kotlin("jvm") version "1.9.10" apply false
-    id("org.polyfrost.multi-version.root")
-    id("com.github.johnrengelman.shadow") version "7.1.2" apply false
+    id("dev.deftu.gradle.multiversion-root")
 }
 
 preprocess {
-    "1.12.2-forge"(11202, "srg") {
-        "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") {
+                "1.8.9-fabric"(10809, "yarn")
+            }
+        }
     }
+
+    strictExtraMappings.set(true)
 }

settings.gradle.kts

@@ -1,27 +1,49 @@
 @file:Suppress("PropertyName")
 
+import groovy.lang.MissingPropertyException
+
 pluginManagement {
     repositories {
+        // Releases
+        maven("https://maven.deftu.dev/releases")
+        maven("https://maven.fabricmc.net")
+        maven("https://maven.architectury.dev/")
+        maven("https://maven.minecraftforge.net")
+        maven("https://repo.essential.gg/repository/maven-public")
+        maven("https://server.bbkr.space/artifactory/libs-release/")
+        maven("https://jitpack.io/")
+
+        // Snapshots
+        maven("https://maven.deftu.dev/snapshots")
+        mavenLocal()
+
+        // Default
         gradlePluginPortal()
         mavenCentral()
-        maven("https://repo.polyfrost.org/releases") // Adds the Polyfrost maven repository to get Polyfrost Gradle Toolkit
     }
+
     plugins {
-        val pgtVersion = "0.2.9" // Sets the default versions for Polyfrost Gradle Toolkit
-        id("org.polyfrost.multi-version.root") version pgtVersion
+        kotlin("jvm") version("2.0.0")
+        id("dev.deftu.gradle.multiversion-root") version("2.18.1")
     }
 }
 
-val mod_name: String by settings
+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 = mod_name
+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` FILE WITH THE NEW VERSION(S).
 listOf(
-    "1.8.9-forge", // Update this if you want to remove/add a version, along with `build.gradle.kts` and `root.gradle.kts`.
-    "1.12.2-forge"
+    "1.8.9-forge",
+    "1.8.9-fabric",
+    "1.12.2-fabric",
+    "1.12.2-forge",
 ).forEach { version ->
     include(":$version")
     project(":$version").apply {

…lyweather/mixin/EntityRendererMixin.java …yRenderer_ForceRainAndSnowParticles.javasrc/main/java/org/polyfrost/polyweather/mixin/EntityRendererMixin.java renamed to src/main/java/org/polyfrost/polyweather/mixin/Mixin_EntityRenderer_ForceRainAndSnowParticles.java src/main/java/org/polyfrost/polyweather/mixin/EntityRendererMixin.java renamed to src/main/java/org/polyfrost/polyweather/mixin/Mixin_EntityRenderer_ForceRainAndSnowParticles.java

@@ -1,19 +1,19 @@
 package org.polyfrost.polyweather.mixin;
 
 import net.minecraft.client.renderer.EntityRenderer;
-import org.polyfrost.polyweather.PolyWeather;
-import org.polyfrost.polyweather.config.ModConfig;
+import org.polyfrost.polyweather.client.PolyWeatherClient;
+import org.polyfrost.polyweather.client.PolyWeatherConfig;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.injection.At;
 import org.spongepowered.asm.mixin.injection.Inject;
 import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
 
 @Mixin(EntityRenderer.class)
-public class EntityRendererMixin {
+public class Mixin_EntityRenderer_ForceRainAndSnowParticles {
 
     @Inject(method = "addRainParticles", at = @At("HEAD"), cancellable = true)
     private void addRainParticles(CallbackInfo ci) {
-        if (ModConfig.INSTANCE.enabled && (!PolyWeather.INSTANCE.isRaining() || PolyWeather.INSTANCE.isSnowing())) {
+        if (PolyWeatherConfig.INSTANCE.enabled && (!PolyWeatherClient.isRaining() || PolyWeatherClient.isSnowing())) {
             ci.cancel();
         }
     }