feat: share Fabric and NeoForge runtime with Architectury

Author: Neamyoo-dev

.github/scripts/fabric-smoke.py

@@ -20,7 +20,7 @@
 
 PROJECT_ID = "VW7EmMIj"
 API = "https://api.modrinth.com/v2"
-FABRIC_GAMES = {"26.1.2", "26.2"}
+MOD_GAMES = {"26.1.2", "26.2"}
 USER_AGENT = "EClean-Modern/version-names (https://github.com/MeowCat-Team/EClean-modern)"
 GUARDED_FIELDS = (
     "id", "project_id", "files", "dependencies", "loaders", "game_versions", "changelog",
@@ -136,6 +136,8 @@ def build_plan(versions: Any, base: str) -> list[Rename]:
             selected.append((version, "paper"))
         elif number.startswith(base + "+fabric."):
             selected.append((version, "fabric"))
+        elif number.startswith(base + "+neoforge."):
+            selected.append((version, "neoforge"))
     if not selected:
         raise RenameError(f"No existing versions match base_version {base}; nothing was modified")
 
@@ -154,10 +156,11 @@ def build_plan(versions: Any, base: str) -> list[Rename]:
         loader_set = set(loaders)
         if len(loader_set) != len(loaders):
             raise RenameError(f"Version {version_id} has duplicate loaders")
-        if loader_set == {"fabric"}:
-            platform, label = "fabric", "Fabric"
-            if len(games) != 1 or games[0] not in FABRIC_GAMES:
-                raise RenameError(f"Fabric version {version_id} must have one supported game version (26.1.2 or 26.2)")
+        if loader_set in ({"fabric"}, {"neoforge"}):
+            platform = next(iter(loader_set))
+            label = "Fabric" if platform == "fabric" else "NeoForge"
+            if len(games) != 1 or games[0] not in MOD_GAMES:
+                raise RenameError(f"{label} version {version_id} must have one supported game version (26.1.2 or 26.2)")
             game = games[0]
         elif loader_set <= {"paper", "folia"}:
             platform, label = "paper", "Paper / Folia"
@@ -169,7 +172,7 @@ def build_plan(versions: Any, base: str) -> list[Rename]:
                 raise RenameError(f"Paper version {version_id} has gaps in its declared compatibility range")
             game = ordered[0] if len(ordered) == 1 else f"{ordered[0]}-{ordered[-1]}"
         else:
-            raise RenameError(f"Version {version_id} is not exclusively Paper/Folia or Fabric")
+            raise RenameError(f"Version {version_id} is not exclusively Paper/Folia, Fabric, or NeoForge")
         target_number = f"{base}+{platform}.{game}"
         if suffix is not None and (suffix != platform or version["version_number"] != target_number):
             raise RenameError(f"Version {version_id} platform suffix does not match its loaders and game version")

.github/scripts/mod-smoke.py

@@ -2,9 +2,9 @@ name: Build
 
 on:
   pull_request:
-    branches: [modern]
+    branches: [architectury]
   push:
-    branches: [modern]
+    branches: [architectury]
 
 permissions:
   contents: read
@@ -111,11 +111,12 @@ jobs:
           include-hidden-files: true
           if-no-files-found: ignore
 
-  fabric:
+  mods:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
+        loader: [fabric, neoforge]
         minecraft: ["26.1.2", "26.2"]
     steps:
       - name: Checkout
@@ -130,27 +131,28 @@ jobs:
       - name: Set up Gradle
         uses: gradle/actions/setup-gradle@0b6dd653ba04f4f93bf581ec31e66cbd7dcb644d # v4
 
-      - name: Build and test Fabric
-        run: ./gradlew :common:check :fabric:build -PminecraftVersion=${{ matrix.minecraft }}
+      - name: Build and test server mod
+        run: ./gradlew :common:check :mod-common:check :${{ matrix.loader }}:build -PminecraftVersion=${{ matrix.minecraft }}
 
-      - name: Smoke test packaged Fabric mod
+      - name: Smoke test packaged server mod
         timeout-minutes: 10
-        run: python3 .github/scripts/fabric-smoke.py ${{ matrix.minecraft }}
+        run: python3 .github/scripts/mod-smoke.py ${{ matrix.loader }} ${{ matrix.minecraft }}
 
-      - name: Upload Fabric smoke logs
+      - name: Upload server mod smoke logs and report
         if: always()
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
-          name: EClean-Fabric-smoke-${{ matrix.minecraft }}
+          name: EClean-${{ matrix.loader }}-smoke-${{ matrix.minecraft }}
           path: |
-            .local/fabric-smoke/${{ matrix.minecraft }}/smoke-console.log
-            .local/fabric-smoke/${{ matrix.minecraft }}/logs/latest.log
+            .local/${{ matrix.loader }}-smoke/${{ matrix.minecraft }}/smoke-console.log
+            .local/${{ matrix.loader }}-smoke/${{ matrix.minecraft }}/smoke-report.json
+            .local/${{ matrix.loader }}-smoke/${{ matrix.minecraft }}/logs/latest.log
           include-hidden-files: true
           if-no-files-found: ignore
 
-      - name: Upload Fabric mod
+      - name: Upload server mod
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
-          name: EClean-Modern-Fabric-${{ matrix.minecraft }}
-          path: fabric/build/${{ matrix.minecraft }}/libs/EClean-Modern-*-fabric-mc${{ matrix.minecraft }}.jar
+          name: EClean-Modern-${{ matrix.loader }}-${{ matrix.minecraft }}
+          path: ${{ matrix.loader }}/build/${{ matrix.minecraft }}/libs/EClean-Modern-*-${{ matrix.loader }}-mc${{ matrix.minecraft }}.jar
           if-no-files-found: error

.github/scripts/modrinth-names.py

@@ -24,7 +24,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
         with:
-          ref: modern
+          ref: architectury
           persist-credentials: false
 
       - name: Validate and apply version names

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
         with:
-          ref: modern
+          ref: architectury
           fetch-depth: 0
 
       - name: Read project version
@@ -82,8 +82,8 @@ jobs:
       - name: Build and test
         run: ./gradlew build
 
-      - name: Build and test Fabric 26.2
-        run: ./gradlew :fabric:build -PminecraftVersion=26.2
+      - name: Build and test Fabric and NeoForge 26.2
+        run: ./gradlew :mod-common:check :fabric:build :neoforge:build -PminecraftVersion=26.2
 
       - name: Test packaged Paper plugin on every supported version
         timeout-minutes: 30
@@ -121,20 +121,32 @@ jobs:
 
       - name: Test packaged Fabric 26.1.2 server
         timeout-minutes: 10
-        run: python3 .github/scripts/fabric-smoke.py 26.1.2
+        run: python3 .github/scripts/mod-smoke.py fabric 26.1.2
 
       - name: Test packaged Fabric 26.2 server
         timeout-minutes: 10
-        run: python3 .github/scripts/fabric-smoke.py 26.2
+        run: python3 .github/scripts/mod-smoke.py fabric 26.2
 
-      - name: Upload Fabric server test logs
+      - name: Test packaged NeoForge 26.1.2 server
+        timeout-minutes: 10
+        run: python3 .github/scripts/mod-smoke.py neoforge 26.1.2
+
+      - name: Test packaged NeoForge 26.2 server
+        timeout-minutes: 10
+        run: python3 .github/scripts/mod-smoke.py neoforge 26.2
+
+      - name: Upload server mod test logs and reports
         if: always()
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
-          name: Fabric-release-server-logs
+          name: Mod-release-server-logs
           path: |
             .local/fabric-smoke/*/smoke-console.log
+            .local/fabric-smoke/*/smoke-report.json
             .local/fabric-smoke/*/logs/latest.log
+            .local/neoforge-smoke/*/smoke-console.log
+            .local/neoforge-smoke/*/smoke-report.json
+            .local/neoforge-smoke/*/logs/latest.log
           include-hidden-files: true
           if-no-files-found: ignore
 
@@ -167,6 +179,8 @@ jobs:
             paper/build/libs/EClean-Modern-*-paper.jar
             fabric/build/26.1.2/libs/EClean-Modern-*-fabric-mc26.1.2.jar
             fabric/build/26.2/libs/EClean-Modern-*-fabric-mc26.2.jar
+            neoforge/build/26.1.2/libs/EClean-Modern-*-neoforge-mc26.1.2.jar
+            neoforge/build/26.2/libs/EClean-Modern-*-neoforge-mc26.2.jar
           fail_on_unmatched_files: true
 
   publish-modrinth:
@@ -202,39 +216,60 @@ jobs:
           game-versions: ${{ needs.release.outputs.game-versions }}
           java: '25'
 
-  publish-modrinth-fabric:
+  publish-modrinth-mods:
     needs: release
     runs-on: ubuntu-latest
     permissions:
       contents: read
     strategy:
       fail-fast: false
       matrix:
-        minecraft: ['26.1.2', '26.2']
+        include:
+          - loader: fabric
+            label: Fabric
+            minecraft: '26.1.2'
+            dependencies: |
+              fabric-api(required)
+              architectury-api(required)
+          - loader: fabric
+            label: Fabric
+            minecraft: '26.2'
+            dependencies: |
+              fabric-api(required)
+              architectury-api(required)
+          - loader: neoforge
+            label: NeoForge
+            minecraft: '26.1.2'
+            dependencies: 'architectury-api(required)'
+          - loader: neoforge
+            label: NeoForge
+            minecraft: '26.2'
+            dependencies: 'architectury-api(required)'
     steps:
-      - name: Download Fabric release artifact
+      - name: Download server mod release artifact
         env:
           GH_TOKEN: ${{ github.token }}
           RELEASE_VERSION: ${{ needs.release.outputs.version }}
           MINECRAFT_VERSION: ${{ matrix.minecraft }}
+          MOD_LOADER: ${{ matrix.loader }}
         run: |
           gh release download "v$RELEASE_VERSION" --repo "$GITHUB_REPOSITORY" \
-            --pattern "EClean-Modern-*-fabric-mc$MINECRAFT_VERSION.jar" --dir release
+            --pattern "EClean-Modern-*-$MOD_LOADER-mc$MINECRAFT_VERSION.jar" --dir release
           gh release view "v$RELEASE_VERSION" --repo "$GITHUB_REPOSITORY" \
             --json body --jq .body > release_notes.md
 
-      - name: Publish Fabric to Modrinth
+      - name: Publish server mod to Modrinth
         uses: Kira-NT/mc-publish@52307b03863581dec6b652b83e597aec02ebb075 # v3.3
         with:
           modrinth-id: VW7EmMIj # ecl-modern
           modrinth-token: ${{ secrets.MODRINTH_TOKEN }}
-          files: release/EClean-Modern-*-fabric-mc${{ matrix.minecraft }}.jar
-          modrinth-name: ${{ needs.release.outputs.version }} (Fabric, MC ${{ matrix.minecraft }})
-          modrinth-version: ${{ needs.release.outputs.version }}+fabric.${{ matrix.minecraft }}
+          files: release/EClean-Modern-*-${{ matrix.loader }}-mc${{ matrix.minecraft }}.jar
+          modrinth-name: ${{ needs.release.outputs.version }} (${{ matrix.label }}, MC ${{ matrix.minecraft }})
+          modrinth-version: ${{ needs.release.outputs.version }}+${{ matrix.loader }}.${{ matrix.minecraft }}
           version-type: release
           changelog-file: release_notes.md
-          loaders: fabric
+          loaders: ${{ matrix.loader }}
           environment: server
           game-versions: ${{ matrix.minecraft }}
-          modrinth-dependencies: fabric-api(required)
+          modrinth-dependencies: ${{ matrix.dependencies }}
           java: '25'

.github/workflows/modrinth-names.yml

@@ -9,4 +9,5 @@ run
 .local
 /.planning/
 /fabric/logs/
+/mod-common/logs/
 __pycache__/

.github/workflows/release.yml

@@ -2,7 +2,7 @@
 
 [English](README.md) | 简体中文
 
-面向 Paper / Folia 的实体清理插件，同时支持 Fabric 26.1.2 / 26.2 服务端，基于 [EClean](https://github.com/4o4E/EClean) 开发。支持定时清理、规则保护、清理预览、共享垃圾桶和可视化统计。
+面向 Paper / Folia 的实体清理插件，同时通过 Architectury 支持 Fabric 和 NeoForge 26.1.2 / 26.2 服务端，基于 [EClean](https://github.com/4o4E/EClean) 开发。支持定时清理、规则保护、清理预览、共享垃圾桶和可视化统计。开发主分支为 `architectury`。
 
 [下载](https://github.com/MeowCat-Team/EClean-modern/releases/latest) · [更新日志](docs/Changelog-zh.md) · [English changelog](docs/Changelog.md)
 
@@ -14,7 +14,7 @@
 
 垃圾桶内容不跨重启保留。更新插件时请完整停服后替换 JAR。
 
-Fabric 服务端请将匹配 **26.1.2 或 26.2** 的模组 JAR、对应 Fabric API 放入 `mods/`，并使用 Fabric Loader 0.19.5 或更新版本。配置生成于 `config/eclean/`，客户端无需安装模组。版本要求、权限与平台差异见 [Fabric 使用说明](docs/Fabric-zh.md)。
+Fabric 或 NeoForge 服务端请将匹配 **26.1.2 或 26.2** 的 EClean 与 Architectury API 放入 `mods/`；Fabric 还需对应的 Fabric API。配置生成于 `config/eclean/`，客户端无需安装模组。具体依赖、权限与安装方法见 [Fabric 使用说明](docs/Fabric-zh.md) 或 [NeoForge 使用说明](docs/NeoForge-zh.md)。
 
 ## 常用命令
 
@@ -36,5 +36,6 @@ Fabric 服务端请将匹配 **26.1.2 或 26.2** 的模组 JAR、对应 Fabric A
 - [权限列表](docs/Permissions-zh.md)
 - [Paper 版本与兼容性验证](docs/Paper-zh.md)
 - [Fabric 安装与兼容性](docs/Fabric-zh.md)
+- [NeoForge 安装与兼容性](docs/NeoForge-zh.md)
 - [PlaceholderAPI 占位符](docs/Placeholders-zh.md)
 - [构建与依赖更新](docs/Building-zh.md)

.gitignore

@@ -2,7 +2,7 @@
 
 English | [简体中文](README-zh.md)
 
-An entity cleanup plugin for Paper / Folia and a server mod for Fabric 26.1.2 / 26.2, based on [EClean](https://github.com/4o4E/EClean). Supports scheduled cleanup, protection rules, cleanup previews, a shared trash can, and visual statistics.
+An entity cleanup plugin for Paper / Folia and an Architectury server mod for Fabric and NeoForge 26.1.2 / 26.2, based on [EClean](https://github.com/4o4E/EClean). Supports scheduled cleanup, protection rules, cleanup previews, a shared trash can, and visual statistics. Development takes place on the `architectury` branch.
 
 [Download](https://github.com/MeowCat-Team/EClean-modern/releases/latest) · [Changelog](docs/Changelog.md)
 
@@ -14,7 +14,7 @@ An entity cleanup plugin for Paper / Folia and a server mod for Fabric 26.1.2 /
 
 Trash-can contents do not survive server restarts. Shut down the server completely before replacing the plugin JAR.
 
-For Fabric, install the JAR matching **26.1.2 or 26.2**, Fabric Loader 0.19.5 or newer, and the matching Fabric API in `mods/`. Configuration is generated under `config/eclean/`. Clients need no mod. See the [Fabric guide](docs/Fabric.md) for versions, permissions, and platform differences.
+For Fabric or NeoForge, install the EClean JAR and Architectury API matching **26.1.2 or 26.2** in `mods/`. Fabric additionally requires Fabric API. Configuration is generated under `config/eclean/`; clients need no mod. See the [Fabric guide](docs/Fabric.md) or [NeoForge guide](docs/NeoForge.md) for exact dependencies, permissions, and installation.
 
 ## Common commands
 
@@ -36,5 +36,6 @@ The main command is `/eclean`, with `/ecl` as an alias. Commands require OP perm
 - [Permissions](docs/Permissions.md)
 - [Paper versions and compatibility checks](docs/Paper.md)
 - [Fabric installation and compatibility](docs/Fabric.md)
+- [NeoForge installation and compatibility](docs/NeoForge.md)
 - [PlaceholderAPI variables](docs/Placeholders.md)
 - [Building and updating dependencies](docs/Building.md)

README-zh.md

@@ -3,11 +3,23 @@ plugins {
     alias(libs.plugins.kotlin.serialization) apply false
     alias(libs.plugins.shadow) apply false
     alias(libs.plugins.run.paper) apply false
+    alias(libs.plugins.architectury.loom) apply false
+    alias(libs.plugins.architectury.plugin)
 }
 
+val minecraftVersion = providers.gradleProperty("minecraftVersion").getOrElse("26.1.2")
+require(minecraftVersion in setOf("26.1.2", "26.2")) {
+    "EClean mods support Minecraft 26.1.2 and 26.2; received '$minecraftVersion'."
+}
+architectury {
+    minecraft = minecraftVersion
+}
+// Select NeoForge before its Loom plugin is applied. Paper and common never apply Loom.
+project(":neoforge").extensions.extraProperties["loom.platform"] = "neoforge"
+
 allprojects {
     group = "org.meowcat"
-    version = "0.3.5"
+    version = "0.3.6"
 
     repositories {
         mavenCentral()