Switch resource replacing to blossom, update readme

Author: kappa-maintainer

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,47 @@ 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 `gradle/scripts/dependencies.gradle`.
+### 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.
 
 ### Access Transformer
-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. 
+You **MUST** write AT file in MCP name. It will be remapped back to SRG name in artifact jar.
 
-**WARNING**: ATs from dependency won't be applied to vanilla source. 
+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.
 
-### 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,7 +67,7 @@ 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

build.gradle

@@ -5,7 +5,7 @@ plugins {
     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'
 }
 
 import org.jetbrains.gradle.ext.Gradle
@@ -48,9 +48,7 @@ java {
 }
 
 configurations {
-    embed
     contain
-    implementation.extendsFrom(embed)
     implementation.extendsFrom(contain)
     modCompileOnly
     compileOnly.extendsFrom(modCompileOnly)
@@ -120,33 +118,6 @@ dependencies {
 apply from: 'gradle/scripts/dependencies.gradle'
 
 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', ',').join(', ')}"
-    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')
-
-    def filterList = ['mcmod.info', 'pack.mcmeta']
-
-    filesMatching(filterList) { fcd ->
-        fcd.expand(
-                'mod_id': propertyString('mod_id'),
-                'mod_name': propertyString('mod_name'),
-                'mod_version': propertyString('mod_version'),
-                'mod_description': propertyString('mod_description'),
-                'mod_authors': "${propertyStringList('mod_authors', ',').join(', ')}",
-                'mod_credits': propertyString('mod_credits'),
-                'mod_url': propertyString('mod_url'),
-                'mod_update_json': propertyString('mod_update_json'),
-                'mod_logo_path': propertyString('mod_logo_path'),
-        )
-    }
-
     rename '(.+_at.cfg)', 'META-INF/$1'
 }
 
@@ -159,6 +130,17 @@ sourceSets {
                 property('mod_version', propertyString('mod_version'))
                 property('package', "${root_package}.${mod_id}")
             }
+            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', ',').join(', ')}")
+                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'))
+            }
         }
     }
 }
@@ -201,6 +183,7 @@ compileJava {
 }
 
 jar {
+    archiveClassifier = 'dev'
     duplicatesStrategy = DuplicatesStrategy.EXCLUDE
     if (configurations.contain.size() > 0) {
         into('/') {

gradle/scripts/dependencies.gradle

@@ -37,7 +37,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

settings.gradle

@@ -1,5 +1,10 @@
 pluginManagement {
     repositories {
+        gradlePluginPortal() {
+            content {
+                excludeGroup("org.apache.logging.log4j")
+            }
+        }
         mavenCentral()
         maven {
             url = "https://maven.minecraftforge.net/"
@@ -17,11 +22,6 @@ pluginManagement {
         maven {
             url = "https://maven.wagyourtail.xyz/snapshots"
         }
-        gradlePluginPortal() {
-            content {
-                excludeGroup("org.apache.logging.log4j")
-            }
-        }
     }
 }
 

src/main/java/com/example/modid/ExampleMod.java

@@ -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;
@@ -23,6 +24,7 @@ public class ExampleMod {
     public void preInit(FMLPreInitializationEvent event) {
         LOGGER.info("Hello From {}!", Reference.MOD_NAME);
         LOGGER.info("Proxy is {}", proxy);
+        LOGGER.info("Language: {}", Minecraft.getMinecraft().getLanguageManager().getCurrentLanguage());
     }
 
 }

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 }}"
+}]

src/main/resource-templates/pack.mcmeta

@@ -0,0 +1,6 @@
+{
+	"pack": {
+		"description": "{{ mod_name }} Resources",
+		"pack_format": 3
+	}
+}