Merge branch 'main' into kotlin

kappa-maintainer · kappa-maintainer · commit 4b273256708c · 2026-03-02T16:14:51.000+08:00
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 # CleanroomModTemplate
 Mod development template for Cleanroom, uses Unimined
 
-## Usage
+## DOs and DON'Ts
 ### Choose Branch
 Choose mixin branch if you want to use Mixin.
 
-Use scala and kotlin branch if you want to write in non-Java language. 
+Use scala and kotlin branch if you want to use those languages. 
 
 There are 4 branches available:
 - main
@@ -15,61 +15,48 @@ There are 4 branches available:
 
 If you want to use non-main branches, after clicked *Create a new repository* under *Use this template*, check the *Include all branches* checkbox.
 
-### gradle.properties
-Edit gradle.properties and set your modid, mod version, mod name, package, etc.
-
-If you are writing a coremod, remember to set related settings to true.
-
-### Reference Class
-Mostly used to store mod version so you can fill it to `@Mod`.
 
-You should change its location to fit your new package name.
-
-You can find it under `src/main/java-templates`.
-
-### Dependencies
-You can find dependency script in `buildSrc/src/main/kotlin/dependencies.gradle.kts`.
+### Running Client or Server
+If you are using IntelliJ, **DO NOT** use the `Minecraft Client` configure with a blue icon. Just use the `2. Run Client` Gradle task.
 
-No more `rfg.deobf()` or `fg.deobf` for mods, you should use `modImplementation`, `modCompileOnly` and `modRuntimeOnly`.
+### Adding Mod Dependencies
+You can find dependencies block in `gradle/scripts/dependencies.gradle`.
 
-### Shadow
-You can use `shadow` in dependency declaration to shadow libraries.
+No more `rfg.deobf()` or `fg.deobf`. You **MUST** add mods by using `modImplementation` or `modRuntimeOnly`, or the game will crash when running.
 
-### Contain
-You can use `contain` in dependency declaration to add non-mod libraries to artifact jar.
+### Non-Mod Dependencies
+Two new configuration types `contain` and `shadow` are available, check more details in `dependencies.gradle`.
 
-They will be extracted and loaded automatically in production.
+### gradle.properties
+Edit gradle.properties and set your modid, mod version, mod name, package, etc.
 
-### Mixin
-MixinBooter API is deprecated in Cleanroom.
+If you are writing a coremod, remember to set related settings to true.
 
-Current approach is to set json configs in `MixinConfigs` manifest key, which will be read by Cleanroom.
+### Reference Class
+There will be a `Reference` class under your top package.
 
-You don't need to set tons of json too. If you aren't mixining into Forge, all you need is two jsons for `DEFAULT` hase and `MOD` Phase.
+This is used to store mod version so you can fill it to `@Mod` annotation.
 
-All you need is to put `IEarlyMixinLoader` mixin to `DEFAULT` json, and, mixins from `ILateMixinLoader` to `MOD` json.
+You should change its location to fit your new package name.
 
-As for calling `Loader.isModLoaded()`, just fit an `IMixinConfigPlugin` to your json and call in `shouldApply()`
+You can find its template under `src/main/java-templates`.
 
-There are some example mixins and a HEI dependency in mixin fork, remove them before writing yours.
+### Mixin
+1. Rename json config file to include your modid. You will need one json per phase (`PRE_INIT`, `DEFAULT`, `MOD`) 
+2. Add your mixin classes there.
+3. Use `IMixinConfigPlugin` to control if certain mixin should be enabled. You can call `Loader.isModLoaded()` for `MOD` phase mixins.
+4. Don't worry about refmap, Unimined will handle it automatically. You can still `disableRefmap()` manually though
 
 ### Access Transformer
-You MUST write AT file in MCP name. It will be remapped back to SRG name in artifact jar.
+You **MUST** write AT file in MCP name. It will be remapped back to SRG name in artifact jar.
 
-Rename AT file name to your modid before using it. There's an example entry in AT file, remove it if you want to use AT. 
+Rename AT file name to your modid before using it. There's an example entry in AT file, remove it if you want to use AT.
 
-**WARNING**: ATs from dependency won't be applied to vanilla source. 
-
-### Source Code with Comments
-Run `genSources` task in gradle.
+### Vanilla Source Code with Comments
+Run `genSources` task in gradle. If it didn't work, run again until a file with `-sources.jar` suffix appeared.
 
 If you want to `find usage` from vanilla like RFG, just change the scope in IntelliJ settings.
 
-### Running Client or Server
-You **MUST** add mods by using `modImplementation` or `modRuntimeOnly`, or mapping and ATs will break.
-
-If you are using IntelliJ, **DO NOT** use the `Minecraft Client` configure with a blue icon. Just use the `runClient` Gradle task.
-
 ### GitHub Action
 This template comes with three workflows.
 
@@ -81,8 +68,9 @@ This template comes with three workflows.
 
 You need to fill in your project IDs and configure your tokens in GitHub repository first.
 
-By default, you will need to manually trigger the workflow in web page, but you can also enable tag triggering by merging it into `release.yml`.
+By default, you will need to manually trigger the workflow in web page, but you can also enable tag triggering by merging the third yml into `release.yml`.
 
 ### Credit
 Thanks @Karnatour for fixing shadow plugin
+
 Thanks @ghostflyby for making kotlin branch
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,13 +1,17 @@
-import xyz.wagyourtail.unimined.api.minecraft.task.RemapJarTask
+import org.jetbrains.gradle.ext.Gradle
+import org.jetbrains.gradle.ext.compiler
+import org.jetbrains.gradle.ext.runConfigurations
+import org.jetbrains.gradle.ext.settings
 
 plugins {
     java
     `java-library`
     `maven-publish`
     kotlin("jvm") version "2.3.10"
-    id("com.gradleup.shadow") version "9.3.0"
+    id("com.gradleup.shadow") version "9.3.2"
+    id("org.jetbrains.gradle.plugin.idea-ext") version "1.4.1"
     id("xyz.wagyourtail.unimined") version "1.4.10-kappa"
-    id("net.kyori.blossom") version "2.1.0"
+    id("net.kyori.blossom") version "2.2.0"
 }
 
 // Early Assertions
@@ -45,17 +49,16 @@ java {
 }
 
 configurations {
-    val embed by creating
     val contain by creating
-    implementation {
-        extendsFrom(embed, contain)
-    }
+    implementation { extendsFrom(contain) }
     val modCompileOnly by creating
     compileOnly { extendsFrom(modCompileOnly) }
     val modRuntimeOnly by creating
     runtimeOnly { extendsFrom(modRuntimeOnly) }
 }
 
+val remapTaskName = if (propertyBool("enable_shadow")) "remapShadowJar" else "remapJar"
+
 unimined.minecraft {
     version("1.12.2")
 
@@ -88,27 +91,21 @@ unimined.minecraft {
 
     defaultRemapJar = false
 
-    if (propertyBool("enable_shadow")) {
-        remap(tasks.shadowJar.get()) {
-            mixinRemap {
-                enableBaseMixin()
-                enableMixinExtra()
-                disableRefmap()
-            }
-        }
-    } else {
-        remap(tasks.jar.get()) {
-            mixinRemap {
-                enableBaseMixin()
-                enableMixinExtra()
-                disableRefmap()
-            }
+    val jarTaskName = if (propertyBool("enable_shadow")) "shadowJar" else "jar"
+
+    remap(tasks.named(jarTaskName).get()) {
+        mixinRemap {
+            enableBaseMixin()
+            enableMixinExtra()
+            disableRefmap()
         }
     }
 
     mods {
         val modCompileOnly by configurations.getting
+        val modRuntimeOnly by configurations.getting
         remap(modCompileOnly)
+        remap(modRuntimeOnly)
     }
 }
 
@@ -117,43 +114,14 @@ dependencies {
         implementation("com.cleanroommc:assetmover:${propertyString("asset_mover_version")}")
     }
     if (propertyBool("enable_junit_testing")) {
-        testImplementation("org.junit.jupiter:junit-jupiter:5.7.1")
+        testImplementation("org.junit.jupiter:junit-jupiter:6.0.2")
         testRuntimeOnly("org.junit.platform:junit-platform-launcher")
     }
 }
 
 apply(plugin = "dependencies")
 
 tasks.processResources {
-
-    inputs.property("mod_id", propertyString("mod_id"))
-    inputs.property("mod_name", propertyString("mod_name"))
-    inputs.property("mod_version", propertyString("mod_version"))
-    inputs.property("mod_description", propertyString("mod_description"))
-    inputs.property("mod_authors", propertyStringList("mod_authors", ",").joinToString(", "))
-    inputs.property("mod_credits", propertyString("mod_credits"))
-    inputs.property("mod_url", propertyString("mod_url"))
-    inputs.property("mod_update_json", propertyString("mod_update_json"))
-    inputs.property("mod_logo_path", propertyString("mod_logo_path"))
-
-    val filterList = listOf("mcmod.info", "pack.mcmeta")
-
-    filesMatching(filterList) {
-        expand(
-            mapOf(
-                "mod_id" to propertyString("mod_id"),
-                "mod_name" to propertyString("mod_name"),
-                "mod_version" to propertyString("mod_version"),
-                "mod_description" to propertyString("mod_description"),
-                "mod_authors" to propertyStringList("mod_authors", ",").joinToString(", "),
-                "mod_credits" to propertyString("mod_credits"),
-                "mod_url" to propertyString("mod_url"),
-                "mod_update_json" to propertyString("mod_update_json"),
-                "mod_logo_path" to propertyString("mod_logo_path"),
-            ),
-        )
-    }
-
     rename("(.+_at.cfg)", "META-INF/$1")
 }
 
@@ -168,6 +136,17 @@ sourceSets {
                 val modId = propertyString("mod_id")
                 property("package", "$rootPackage.$modId")
             }
+            resources {
+                property("mod_id", propertyString("mod_id"))
+                property("mod_name", propertyString("mod_name"))
+                property("mod_version", propertyString("mod_version"))
+                property("mod_description", propertyString("mod_description"))
+                property("mod_authors", "${propertyStringList("mod_authors", ",").joinToString(", ")}")
+                property("mod_credits", propertyString("mod_credits"))
+                property("mod_url", propertyString("mod_url"))
+                property("mod_update_json", propertyString("mod_update_json"))
+                property("mod_logo_path", propertyString("mod_logo_path"))
+            }
         }
     }
 }
@@ -176,6 +155,32 @@ if (!propertyBool("enable_shadow")) {
     tasks.shadowJar { enabled = false }
 }
 
+idea {
+    module {
+        inheritOutputDirs = true
+    }
+    project {
+        settings {
+            runConfigurations {
+                add(Gradle("1. Build").apply {
+                    setProperty("taskNames", listOf("build"))
+                })
+                add(Gradle("2. Run Client").apply {
+                    setProperty("taskNames", listOf("runClient"))
+                })
+                add(Gradle("3. Run Server").apply {
+                    setProperty("taskNames", listOf("runServer"))
+                })
+            }
+            compiler.javac {
+                afterEvaluate {
+                    javacAdditionalOptions = "-encoding utf8"
+                }
+            }
+        }
+    }
+}
+
 tasks.jar {
     duplicatesStrategy = DuplicatesStrategy.EXCLUDE
     val contain by configurations.getting
@@ -204,19 +209,15 @@ tasks.jar {
             attributes(attributeMap)
         }
     }
-    if (propertyBool("enable_shadow")) {
-        finalizedBy(tasks.named("remapShadowJar"))
-    } else {
-        finalizedBy(tasks.named("remapJar"))
-    }
+    finalizedBy(tasks.named(remapTaskName).get())
 }
 
 tasks.shadowJar {
     configurations.add(project.configurations.shadow)
     archiveClassifier = "shadow"
 }
 
-tasks.named<RemapJarTask>("remapJar") {
+tasks.named(remapTaskName) {
     doFirst {
         logging.captureStandardOutput(LogLevel.INFO)
     }
diff --git a/buildSrc/src/main/kotlin/dependencies.gradle.kts b/buildSrc/src/main/kotlin/dependencies.gradle.kts
@@ -43,7 +43,7 @@ dependencies {
     // runtimeOnly = runtime dependency
     // compileOnly = compile time dependency
     // annotationProcessor = annotation processing dependencies
-    // contain = bundle dependency jars into final artifact, will extract them in mod loading. Please only do this to non-mod dependencies.
+    // contain = bundle dependency jars into final artifact, will extract them in mod loading. Can be used it as jar-in-jar
     // shadow = bundle dependencies into shadow output artifact (relocation configurable in shadowJar task)
     // modImplementation = mod dependency available at both compile time and runtime
     // modCompileOnly = mod dependency available only at compile time
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,5 +1,10 @@
 pluginManagement {
     repositories {
+        gradlePluginPortal {
+            content {
+                excludeGroup("org.apache.logging.log4j")
+            }
+        }
         mavenCentral()
         maven {
             setUrl("https://maven.outlands.top/releases")
@@ -19,11 +24,6 @@ pluginManagement {
         maven {
             setUrl("https://maven.outlands.top/releases")
         }
-        gradlePluginPortal {
-            content {
-                excludeGroup("org.apache.logging.log4j")
-            }
-        }
     }
 }
 
diff --git a/src/main/kotlin/com/example/modid/ExampleMod.kt b/src/main/kotlin/com/example/modid/ExampleMod.kt
@@ -1,6 +1,7 @@
 package com.example.modid
 
 import com.example.modid.proxy.IProxy
+import net.minecraft.client.Minecraft
 import net.minecraftforge.fml.common.Mod
 import net.minecraftforge.fml.common.SidedProxy
 import net.minecraftforge.fml.common.event.FMLPreInitializationEvent
@@ -21,5 +22,7 @@ class ExampleMod {
     @Mod.EventHandler
     fun preInit(event: FMLPreInitializationEvent?) {
         LOGGER.info("Hello From {}!", Reference.MOD_NAME)
+        LOGGER.info("Proxy is {}", proxy)
+        LOGGER.info("Language: {}", Minecraft.getMinecraft().languageManager.currentLanguage)
     }
 }
diff --git a/src/main/resource-templates/mcmod.info b/src/main/resource-templates/mcmod.info
@@ -0,0 +1,12 @@
+[{
+	"modid": "{{ mod_id }}",
+	"name": "{{ mod_name }}",
+	"version": "{{ mod_version }}",
+	"mcversion": "1.12.2",
+	"description": "{{ mod_description }}",
+	"authorList": ["{{ mod_authors }}"],
+	"credits": "{{ mod_credits }}",
+	"url": "{{ mod_url }}",
+	"updateJSON": "{{ mod_update_json }}",
+	"logoFile": "{{ mod_logo_path }}"
+}]
diff --git a/src/main/resource-templates/pack.mcmeta b/src/main/resource-templates/pack.mcmeta
@@ -0,0 +1,6 @@
+{
+	"pack": {
+		"description": "{{ mod_name }} Resources",
+		"pack_format": 3
+	}
+}
diff --git a/src/main/resources/mcmod.info b/src/main/resources/mcmod.info
diff --git a/src/main/resources/pack.mcmeta b/src/main/resources/pack.mcmeta

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package com.example.modid`
`2`	`2`
`3`	`3`	`import com.example.modid.proxy.IProxy`
	`4`	`+import net.minecraft.client.Minecraft`
`4`	`5`	`import net.minecraftforge.fml.common.Mod`
`5`	`6`	`import net.minecraftforge.fml.common.SidedProxy`
`6`	`7`	`import net.minecraftforge.fml.common.event.FMLPreInitializationEvent`
`@@ -21,5 +22,7 @@ class ExampleMod {`
`21`	`22`	`@Mod.EventHandler`
`22`	`23`	`fun preInit(event: FMLPreInitializationEvent?) {`
`23`	`24`	`LOGGER.info("Hello From {}!", Reference.MOD_NAME)`
	`25`	`+ LOGGER.info("Proxy is {}", proxy)`
	`26`	`+ LOGGER.info("Language: {}", Minecraft.getMinecraft().languageManager.currentLanguage)`
`24`	`27`	`}`
`25`	`28`	`}`