Merge branch 'main' into mixin

Author: kappa-maintainer

.github/workflows/gradle.yml .github/workflows/build.yml.github/workflows/gradle.yml renamed to .github/workflows/build.yml

@@ -1,10 +1,3 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
-
 name: Build mod jar
 
 on:

.github/workflows/release-to-cf-mr.yml

@@ -0,0 +1,59 @@
+name: Releases to CurseForge and/or Modrinth
+
+on:
+  workflow_dispatch: 
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.2.2
+        with:
+          fetch-depth: 0
+          
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4.7.0
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          
+      - uses: gradle/actions/setup-gradle@v4.3.1
+        with:
+          gradle-version: 9.0.0
+        name: Set up Gradle
+        
+      - name: Add permission
+        run: chmod +x ./gradlew
+        
+      - name: Execute Gradle build
+        run: ./gradlew build
+
+      - name: Get Changes between Tags
+        id: changes
+        uses: simbo/changes-between-tags-action@v1
+
+      - uses: Kir-Antipov/mc-publish@v3.3.0
+        with:
+          # Only include this section if you wish to publish
+          # your assets on Modrinth.
+          modrinth-id: placeholder
+          modrinth-token: ${{ secrets.MODRINTH_TOKEN }}
+
+          # Only include this section if you wish to publish
+          # your assets on CurseForge.
+          curseforge-id: placeholder
+          curseforge-token: ${{ secrets.CURSEFORGE_TOKEN }}
+
+          files: |
+            build/libs/!(*-@(dev|sources|javadoc)).jar
+            build/libs/*-@(dev|sources|javadoc).jar
+          loaders: forge
+          game-versions: 1.12.2
+          java: |
+            21
+            22
+          version: ${{ steps.changes.outputs.tag }}
+          changelog: ${{ steps.changes.outputs.changes }}

.gitignore

@@ -25,5 +25,3 @@ gradle-app.setting
 # IDEA config
 .idea
 
-# Source inject target, change it to your class
-src/main/java/com/example/modid/Reference.java

README.md

@@ -2,18 +2,76 @@
 Mod development template for Cleanroom, uses Unimined
 
 ## Usage
-Edit gradle.properties for general settings
-If you don't need shadow plugin, remove it from build.gradle
-If you want to change artifact file name, also change it in build.gradle
-Mixin in Cleanroom only need 1~3 configs, MixinBooter API is deprecated, check mixin branch for more detail
+### Choose Branch
+Choose mixin branch if you want to use Mixin.
 
-**WARNING**: These features are missing:
-- Inheriting ATs from dependencies. AT in runs works well though. 
+Use scala and kotlin branch if you want to write in non-Java language. 
 
-## Branches
-There are 3 branches available:
+There are 4 branches available:
 - main
 - mixin
 - scala
+- kotlin
 
-If you want to use non-main branches, after clicked *Create a new repository* under *Use this template*, check the *Include all branches* checkbox
+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`.
+
+No more `rfg.deobf()` or `fg.deobf` for mods, you should use `modImplementation`, `modCompileOnly` and `modRuntimeOnly`.
+
+### Shadow
+You can use `shadow` in dependency declaration to shadow libraries.
+
+### Contain
+You can use `contain` in dependency declaration to add non-mod libraries to artifact jar.
+
+They will be extracted and loaded automatically in production.
+
+### Mixin
+MixinBooter API is deprecated in Cleanroom.
+
+Current approach is to set json configs in `MixinConfigs` manifest key, which will be read by Cleanroom.
+
+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.
+
+All you need is to put `IEarlyMixinLoader` mixin to `DEFAULT` json, and, mixins from `ILateMixinLoader` to `MOD` json.
+
+As for calling `Loader.isModLoaded()`, just fit an `IMixinConfigPlugin` to your json and call in `shouldApply()`
+
+There are some example mixins and a HEI dependency in mixin fork, remove them before writing yours.
+
+### 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. 
+
+**WARNING**: ATs from dependency won't be applied to vanilla source. 
+
+### Running Client or Server
+You MUST add mods by using `modImplementation` or `modRuntimeOnly`, or mapping and ATs will break.
+
+### GitHub Action
+This template comes with three workflows.
+
+`build.yml` will build and upload artifact for every commit. Useful when you want to provide test builds for debugging.
+
+`release.yml` will make a GitHub release if you pushed a git tag.
+
+`release-to-cf-mr` can publish your mod to CurseForge and/or Modrinth.
+
+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`.

build.gradle

@@ -1,12 +1,10 @@
-import org.jetbrains.changelog.Changelog
-
 plugins {
     id 'java'
     id 'java-library'
     id 'maven-publish'
-    id 'com.gradleup.shadow' version '9.0.0-rc3' // Remove this line and shadowJar task if you don't need shadow
-    id 'org.jetbrains.changelog' version '2.2.1'
+    id 'com.gradleup.shadow' version '9.0.2'
     id 'xyz.wagyourtail.unimined' version '1.4.1'
+    id 'net.kyori.blossom'  version '2.1.0'
 }
 
 apply from: 'gradle/scripts/helpers.gradle'
@@ -17,10 +15,6 @@ assertProperty 'root_package'
 assertProperty 'mod_id'
 assertProperty 'mod_name'
 
-if (propertyBool('generate_reference_class')) {
-    generateReferenceClass()
-}
-
 assertSubProperties 'use_access_transformer', 'access_transformer_locations'
 assertSubProperties 'is_coremod', 'coremod_includes_mod', 'coremod_plugin_class_name'
 assertSubProperties 'use_asset_mover', 'asset_mover_version'
@@ -56,7 +50,9 @@ configurations {
     implementation.extendsFrom(embed)
     implementation.extendsFrom(contain)
     modCompileOnly
-    compileOnly.extendsFrom modCompileOnly
+    compileOnly.extendsFrom(modCompileOnly)
+    modRuntimeOnly
+    runtimeOnly.extendsFrom(modRuntimeOnly)
 }
 
 unimined.minecraft {
@@ -155,6 +151,23 @@ processResources {
     rename '(.+_at.cfg)', 'META-INF/$1'
 }
 
+sourceSets {
+    main {
+        blossom {
+            javaSources {
+                property('mod_id', propertyString('mod_id'))
+                property('mod_name', propertyString('mod_name'))
+                property('mod_version', propertyString('mod_version'))
+                property('package', "${root_package}.${mod_id}")
+            }
+        }
+    }
+}
+
+if (!propertyBool('enable_shadow')) {
+    shadowJar.enabled = false
+}
+
 jar {
     duplicatesStrategy = DuplicatesStrategy.EXCLUDE
     if (configurations.contain.size() > 0) {
@@ -196,6 +209,15 @@ shadowJar {
     archiveClassifier = "shadow"
 }
 
+remapJar {
+    doFirst {
+        logging.captureStandardOutput LogLevel.INFO
+    }
+    doLast {
+        logging.captureStandardOutput LogLevel.QUIET
+    }
+}
+
 compileTestJava {
     sourceCompatibility = targetCompatibility = JavaVersion.VERSION_21
 }
@@ -212,31 +234,6 @@ test {
     }
 }
 
-String parserChangelog() {
-    if (!file('CHANGELOG.md').exists()) {
-        throw new GradleException('publish_with_changelog is true, but CHANGELOG.md does not exist in the workspace!')
-    }
-    String parsedChangelog = changelog.renderItem(
-            changelog.get(propertyString('mod_version')).withHeader(false).withEmptySections(false),
-            Changelog.OutputType.MARKDOWN)
-    if (parsedChangelog.isEmpty()) {
-        throw new GradleException('publish_with_changelog is true, but the changelog for the latest version is empty!')
-    }
-    return parsedChangelog
-}
-
-def generateReferenceClass() {
-    var target = new File("${rootProject.projectDir}/src/main/java/${root_package.replace('.', '/')}/${mod_id}/Reference.java")
-    var template = new File("${rootProject.projectDir}/template/Reference.java")
-    var replaceMap = [$package : "${root_package}.${mod_id}", $mod_id : mod_id, $mod_name : mod_name, $mod_version : mod_version]
-    target.withWriter { var writer ->
-        template.eachLine { var line ->
-            replaceMap.each {if (line.contains(it.key)) line = line.replace(it.key, it.value)}
-            writer.write(line + "\n");
-        }
-    }
-}
-
 tasks.withType(JavaCompile).configureEach {
     options.encoding = 'UTF-8'
 }

gradle.properties

@@ -47,19 +47,8 @@ publish_to_local_maven = false
 maven_name = ${mod_name}
 maven_url =
 
-# Publishing
-# release_type can only be: release, beta or alpha (applies to CurseForge / Modrinth)
-release_type = release
-publish_with_changelog = ${{ it.file('CHANGELOG.md').exists() }}
-
 # If any properties changes below this line, refresh gradle again to ensure everything is working correctly.
-
-# Generate Reference Class
-# There's a method in build script that generates a reference class with certain fields inside.
-# Normally it will contain modid, mod name and mod version.
-# You can check the template class in template/Reference.java
-# You should change the ignore target in .gitignore if you changed modid or package name
-generate_reference_class = true
+# ----------------------------------------------------------------------------------------------------------------------
 
 # Access Transformers
 # A way to change visibility of Minecraft's classes, methods and fields

src/main/java-templates/com/example/modid/Reference.java

@@ -0,0 +1,13 @@
+package {{ package }};
+
+/**
+ * Tags storage class, you can change at will
+ */
+public class Reference {
+    private Reference() {}
+
+    public static final String MOD_ID = "{{ mod_id }}";
+    public static final String MOD_NAME = "{{ mod_name }}";
+    public static final String VERSION = "{{ mod_version }}";
+
+}