ModularMCLib · QiuYe-123 · Apr 29, 2026 · Apr 29, 2026 · Apr 29, 2026 · Apr 29, 2026
@@ -3,41 +3,41 @@ name: Pull Request Labels
 
 # Checks for label once PR has been reviewed or label is applied
 on:
-  pull_request:
-    types: [opened, labeled, unlabeled]
+    pull_request:
+        types: [opened, labeled, unlabeled]
 
 concurrency:
-  group: pr-labels-${{ github.head_ref }}
-  cancel-in-progress: true
+    group: pr-labels-${{ github.head_ref }}
+    cancel-in-progress: true
 
 jobs:
-  labels:
-    name: Label Check
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: read # needed to utilize required-labels
-    steps:
-      - name: Check for Merge-Blocking Labels # blocks merge if present
-        uses: mheap/github-action-required-labels@v5
-        with:
-          mode: exactly
-          count: 0
-          labels: 'do not merge, admin merge'
-          exit_type: failure
+    labels:
+        name: Label Check
+        runs-on: ubuntu-latest
+        permissions:
+            pull-requests: read # needed to utilize required-labels
+        steps:
+            - name: Check for Merge-Blocking Labels # blocks merge if present
+              uses: mheap/github-action-required-labels@v5
+              with:
+                  mode: exactly
+                  count: 0
+                  labels: 'do not merge, admin merge'
+                  exit_type: failure
 
-      - name: Check for Required Type Labels # require at least one of these labels
-        uses: mheap/github-action-required-labels@v5
-        with:
-          mode: minimum
-          count: 1
-          labels: 'type: feature, type: bugfix, type: refactor, type: translation, type: tests, ignore changelog'
-          exit_type: failure
+            - name: Check for Required Type Labels # require at least one of these labels
+              uses: mheap/github-action-required-labels@v5
+              with:
+                  mode: minimum
+                  count: 1
+                  labels: 'type: feature, type: bugfix, type: refactor, type: translation, type: tests, ignore changelog'
+                  exit_type: failure
+
+            - name: Check for Required Release Label # require exactly one of these labels
+              uses: mheap/github-action-required-labels@v5
+              with:
+                  mode: exactly
+                  count: 1
+                  labels: 'release: api - X.0.0, release: major - 0.X.0, release: Patch - 0.0.X, release: stale'
+                  exit_type: failure
 
-      - name: Check for Required Release Label # require exactly one of these labels
-        uses: mheap/github-action-required-labels@v5
-        with:
-          mode: exactly
-          count: 1
-          labels: 'release: api - X.0.0, release: major - 0.X.0, release: Patch - 0.0.X, release: stale'
-          exit_type: failure
-
@@ -1,34 +1,42 @@
-# Contributing
+# 贡献指南 / Contributing
 
-## Development Baseline
+## 开发基线 / Development Baseline
 
 - Java: `25`
-- Build tool: Gradle wrapper
-- Recommended IDE: IntelliJ IDEA with the generated run configurations
-- Line endings: `LF` via `.gitattributes` and `.editorconfig`
-
-## Local Workflow
-
-1. Sync the Gradle project with a Java 25 runtime.
-2. Make changes inside the package layer that owns the behavior you are touching.
-3. Validate with `./gradlew build` or `gradlew.bat build`.
-4. Use the IDEA run configurations for interactive verification:
-   - `Client`
-   - `Server`
-   - `Data Generation`
-   - `Game Tests`
-   - `Game Tests (Client)`
-
-## Package Boundaries
-
-- Put fluent registration APIs in `com.modularmc.registrate.builders`.
-- Put data generation wiring in `com.modularmc.registrate.providers`.
-- Put generic runtime support code in `com.modularmc.registrate.util`.
-- Keep typed registry wrappers in `com.modularmc.registrate.util.entry`.
-- Avoid adding new public API surface to `util` when the concept belongs in a builder or provider.
-
-## Maintenance Notes
-
-- `RegistrateLib` is the library mod entrypoint for the fork and also holds shared metadata/constants.
-- `src/test/java/com/modularmc/registrate/test/meta` contains maintenance helpers for generated bridge methods.
-- When upstream Registrate changes, update implementation classes first and then re-verify package ownership against `docs/architecture.md`.
+- 构建工具 / Build tool: Gradle wrapper
+- 推荐 IDE / Recommended IDE: IntelliJ IDEA（使用生成的运行配置 / with the generated run configurations）
+- 换行符 / Line endings: `LF`（通过 `.gitattributes` 和 `.editorconfig` / via `.gitattributes` and `.editorconfig`）
+
+## 本地工作流程 / Local Workflow
+
+1. 使用 Java 25 运行时同步 Gradle 项目 / Sync the Gradle project with a Java 25 runtime
+2. 在你所接触的行为所属的包层内进行修改 / Make changes inside the package layer that owns the behavior you are touching
+3. 使用 `./gradlew build` 或 `gradlew.bat build` 验证 / Validate with `./gradlew build` or `gradlew.bat build`
+4. 使用 IDEA 运行配置进行交互式验证 / Use the IDEA run configurations for interactive verification:
+   - `Client` / 客户端
+   - `Server` / 服务端
+   - `Data Generation` / 数据生成
+   - `Game Tests` / 游戏测试
+   - `Game Tests (Client)` / 游戏测试（客户端）
+
+## 包边界 / Package Boundaries
+
+- 流式注册 API 放在 `com.modularmc.registrate.builders`
+  Put fluent registration APIs in `com.modularmc.registrate.builders`
+- 数据生成连接放在 `com.modularmc.registrate.providers`
+  Put data generation wiring in `com.modularmc.registrate.providers`
+- 通用运行时支持代码放在 `com.modularmc.registrate.util`
+  Put generic runtime support code in `com.modularmc.registrate.util`
+- 类型化注册包装器保持在 `com.modularmc.registrate.util.entry`
+  Keep typed registry wrappers in `com.modularmc.registrate.util.entry`
+- 当概念属于 builder 或 provider 时，避免向 `util` 添加新的公开 API 表面
+  Avoid adding new public API surface to `util` when the concept belongs in a builder or provider
+
+## 维护说明 / Maintenance Notes
+
+- `RegistrateLib` 是本分支的库模组入口点，同时持有共享元数据/常量
+  `RegistrateLib` is the library mod entrypoint for the fork and also holds shared metadata/constants
+- `src/test/java/com/modularmc/registrate/test/meta` 包含用于生成的桥接方法的维护辅助工具
+  `src/test/java/com/modularmc/registrate/test/meta` contains maintenance helpers for generated bridge methods
+- 当上游 Registrate 变更时，先更新实现类，然后对照 `docs/architecture.md` 重新验证包所有权
+  When upstream Registrate changes, update implementation classes first and then re-verify package ownership against `docs/architecture.md`
@@ -1,82 +1,110 @@
-# RegistrateLib [![Build Status](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.tterrag.com%2Fjob%2FRegistrate%2Fjob%2F1.21%2F)](https://ci.tterrag.com/job/Registrate/job/1.21) [![License](https://img.shields.io/github/license/ModularMCLib/RegistrateLib?cacheSeconds=36000)](https://www.tldrlegal.com/l/mpl-2.0) [![Maven Version](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fmaven.tterrag.com%2Fcom%2Ftterrag%2Fregistrate%2FRegistrate%2Fmaven-metadata.xml)](https://maven.tterrag.com/com/tterrag/registrate/Registrate) ![Minecraft Version](https://img.shields.io/badge/minecraft-26.1.1-blue) [![Discord](https://img.shields.io/discord/175740881389879296?label=discord&logo=discord&color=7289da)](https://discord.gg/gZqYcEj)
+# RegistrateLib [![License](https://img.shields.io/github/license/ModularMCLib/RegistrateLib?cacheSeconds=36000)](https://www.tldrlegal.com/l/mpl-2.0) ![Minecraft Version](https://img.shields.io/badge/minecraft-26.1.1-blue)
 
+<!-- [![Build Status](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.tterrag.com%2Fjob%2FRegistrate%2Fjob%2F1.21%2F)](https://ci.tterrag.com/job/Registrate/job/1.21) -->
+<!-- [![Maven Version](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fmaven.tterrag.com%2Fcom%2Ftterrag%2Fregistrate%2FRegistrate%2Fmaven-metadata.xml)](https://maven.tterrag.com/com/tterrag/registrate/Registrate) -->
+<!-- Badges below are placeholders for this mod's own CI / Maven: -->
+[![Build Status](#)]()
+[![Maven Version](#)]()
+
+一个用于在你的模组中创建和注册对象的强大封装。  
 A powerful wrapper for creating and registering objects in your mod.
 
-## Fork Status
+---
+
+## 分支状态 / Fork Status
 
+本仓库是 `com.modularmc.registrate` 命名空间下的 Registrate 分支，为 ModularMCLib 生态维护。它追踪上游 Registrate 的设计，同时面向现代 NeoForge + Minecraft `26.1` 工具链，并保留可安全嵌入下游项目的包命名空间。
 This repository is the `com.modularmc.registrate` fork maintained for the ModularMCLib ecosystem. It tracks the upstream Registrate design while targeting the modern NeoForge + Minecraft `26.1` toolchain and preserving a package namespace that can be safely embedded in downstream projects.
 
-## Modern Development
-
-- Use `Java 25` for local builds and IDE sync.
-- Prefer the bundled IDEA run configurations: `Client`, `Server`, `Data Generation`, `Game Tests`, and `Game Tests (Client)`.
-- Keep fluent registration APIs in `builders`, data generation orchestration in `providers`, public reusable helpers in `util`, and implementation plumbing in `internal`.
-- Treat [`docs/architecture.md`](docs/architecture.md) as the source of truth for package responsibilities and extension points.
-- See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the day-to-day development workflow.
-
-## Code Classification
-
-- `com.modularmc.registrate`: public API roots, minimal library bootstrap, and the central registration coordinator.
-- `com.modularmc.registrate.builders`: the fluent DSL used by downstream mods to register content.
-- `com.modularmc.registrate.providers`: data generation orchestration and provider lifecycle management.
-- `com.modularmc.registrate.providers.generators`: blockstate, model, and recipe generator adapters.
-- `com.modularmc.registrate.providers.loot`: loot-table focused provider wrappers.
-- `com.modularmc.registrate.util`: public shared helpers that remain part of the reusable library surface.
-- `com.modularmc.registrate.util.entry`: strongly-typed registry handles returned by builders.
-- `com.modularmc.registrate.util.nullness`: null-safe functional helpers and package defaults.
-- `com.modularmc.registrate.internal`: non-API implementation details extracted from the core runtime.
-- `com.modularmc.registrate.internal.event`: one-shot event wiring used by builders and registration lifecycle hooks.
-- `com.modularmc.registrate.internal.lifecycle`: per-instance lifecycle bridges that keep NeoForge event hookups centralized without collapsing multiple mods into one shared runtime.
-- `com.modularmc.registrate.internal.util`: dist-gated execution and internal logging helpers.
-- `com.modularmc.registrate.test.mod`: the integration-style sample mod where non-library showcase behavior should live.
-- `com.modularmc.registrate.test.gametests`: executable validation scenarios for runtime behavior.
-- `com.modularmc.registrate.test.meta`: maintenance utilities that keep generated bridge methods aligned with upstream APIs.
-
-## Why Registrate?
-
-- Allows you to organize your mod content however you like, rather than having pieces of each object defined in scattered places
-- Simple fluent API
-- Open to extension, build and register custom objects and data
-- Automatic data generation with sane defaults
-- Usable as a standalone NeoForge library mod and as a declared dependency for downstream mods
-
-## How to Use
+---
+
+## 快速链接 / Quick Links
+
+<!-- - [Javadocs](https://ci.tterrag.com/job/Registrate/job/1.21/javadoc/) -->
+- Javadocs（待定 / TBD）
+- [维基 / Wiki](https://github.com/ModularMCLib/RegistrateLib/wiki)
+- [贡献指南 / Contributing](CONTRIBUTING.md)
+
+---
+
+## 为什么使用 Registrate? / Why Registrate?
+
+- 你可以按照自己的方式组织模组内容，无需将每个对象的定义分散在各处
+  Allows you to organize your mod content however you like, rather than having pieces of each object defined in scattered places
+- 简洁的流式 API / Simple fluent API
+- 可扩展，支持构建和注册自定义对象及数据
+  Open to extension, build and register custom objects and data
+- 自动数据生成，提供合理的默认值
+  Automatic data generation with sane defaults
+- 既可作为独立的 NeoForge 库模组使用，也可作为下游模组的声明依赖使用
+  Usable as a standalone NeoForge library mod and as a declared dependency for downstream mods
+
+---
+
+## 代码分类 / Code Classification
 
+- `com.modularmc.registrate` — 公开 API 入口、最小化的库引导、注册协调中心 / public API roots, minimal library bootstrap, and the central registration coordinator
+- `com.modularmc.registrate.builders` — 下游模组用于注册内容的流式 DSL / the fluent DSL used by downstream mods to register content
+- `com.modularmc.registrate.providers` — 数据生成编排与提供者生命周期管理 / data generation orchestration and provider lifecycle management
+- `com.modularmc.registrate.providers.generators` — 方块状态、模型和配方生成器适配器 / blockstate, model, and recipe generator adapters
+- `com.modularmc.registrate.providers.loot` — 战利品表提供者封装 / loot-table focused provider wrappers
+- `com.modularmc.registrate.util` — 公开的共享辅助工具 / public shared helpers that remain part of the reusable library surface
+- `com.modularmc.registrate.util.entry` — 构建器返回的强类型注册句柄 / strongly-typed registry handles returned by builders
+- `com.modularmc.registrate.util.nullness` — 空安全的函数式辅助与包级默认值 / null-safe functional helpers and package defaults
+- `com.modularmc.registrate.internal` — 核心运行时的非 API 实现细节 / non-API implementation details extracted from the core runtime
+- `com.modularmc.registrate.internal.event` — 用于构建器和注册生命周期钩子的一次性事件连接 / one-shot event wiring used by builders and registration lifecycle hooks
+- `com.modularmc.registrate.internal.lifecycle` — 实例级生命周期桥接 / per-instance lifecycle bridges
+- `com.modularmc.registrate.internal.util` — 分发限制执行与内部日志辅助 / dist-gated execution and internal logging helpers
+- `com.modularmc.registrate.test.mod` — 集成测试示例模组 / the integration-style sample mod
+- `com.modularmc.registrate.test.gametests` — 可执行的运行时验证场景 / executable validation scenarios for runtime behavior
+- `com.modularmc.registrate.test.meta` — 维护工具，使生成的桥接方法与上游 API 保持一致 / maintenance utilities that keep generated bridge methods aligned with upstream APIs
+
+---
+
+## 使用方法 / How to Use
+
+首先，创建一个 `Registrate` 对象，该对象将在整个项目中使用。  
 First, create a `Registrate` object which will be used across your entire project.
 
 ```java
 public static final Registrate REGISTRATE = Registrate.create(MOD_ID);
 ```
 
+不一定要使用常量字段，可以在注册设置完成后传递或丢弃。  
 Using a constant field is not necessary, it can be passed around and thrown away after registration is setup.
 
+如果在 `@Mod` 类中声明为 `static`，必须延迟创建 `Registrate` 对象，避免在加载过程中过早创建。可以这样轻松实现：  
 If declared static in your `@Mod` class, you must create the `Registrate` object lazily so it is not created too early during loading. This can be done easily like so:
 
 ```java
 public static final NonNullSupplier<Registrate> REGISTRATE = NonNullSupplier.lazy(() -> Registrate.create(MOD_ID));
 ```
 
+接下来，开始添加对象。  
 Next, begin adding objects.
 
-If you have a block class such as
+如果你有一个方块类：  
+If you have a block class such as:
 
 ```java
 public class MyBlock extends Block {
 
     public MyBlock(Block.Properties properties) {
         super(properties);
     }
-    
+
     ...
 }
 ```
 
-then register it like so,
+可以这样注册：  
+then register it like so:
 
 ```java
 public static final RegistryEntry<MyBlock> MY_BLOCK = REGISTRATE.block("my_block", MyBlock::new).register();
 ```
 
+Registrate 会创建一个方块，并生成默认的简单方块状态、模型、战利品表和语言条目。所有这些方面都可以轻松配置为自定义数据。例如：  
 Registrate will create a block, with a default simple blockstate, model, loot table, and lang entry. However, all of these facets can be configured easily to use whatever custom data you may want. Example:
 
 ```java
@@ -89,14 +117,19 @@ public static final RegistryEntry<MyStairsBlock> MY_STAIRS = REGISTRATE.block("m
             .register();
 ```
 
+这个自定义版本会创建 BlockItem（含默认模型和语言条目）、将方块添加到标签、配置楼梯属性方块状态，并添加自定义本地化。  
 This customized version will create a BlockItem (with its own default model and lang entry), add the block to a tag, configure the blockstate for stair properties, and add a custom localization.
 
-To get an overview of the different APIs and methods, check out the [Javadocs](https://ci.tterrag.com/job/Registrate/job/1.21/javadoc/). For more advanced usage, read the [wiki](https://github.com/ModularMCLib/RegistrateLib/wiki) (WIP).
+<!-- 有关不同 API 和方法的概述，请查阅 [Javadocs](https://ci.tterrag.com/job/Registrate/job/1.21/javadoc/)。 -->
+有关不同 API 和方法的概述，请查阅 Javadocs（待定）。更高级的用法请阅读 [维基](https://github.com/ModularMCLib/RegistrateLib/wiki)（编写中）。  
+<!-- To get an overview of the different APIs and methods, check out the [Javadocs](https://ci.tterrag.com/job/Registrate/job/1.21/javadoc/). -->
+To get an overview of the different APIs and methods, check out the Javadocs (TBD). For more advanced usage, read the [wiki](https://github.com/ModularMCLib/RegistrateLib/wiki) (WIP).
 
-## Project Setup
+---
 
-For this `26.1` fork, the preferred integration model is to depend on RegistrateLib as a normal NeoForge library mod and declare it as a required dependency in your own metadata. Bundling remains possible for tightly controlled distributions, but standalone dependency loading is the default posture for this branch.
+## 项目设置 / Project Setup
 
+将库添加到 Gradle 依赖：  
 Add the library to your Gradle dependencies:
 
 ```groovy
@@ -105,6 +138,7 @@ dependencies {
 }
 ```
 
+然后在 `neoforge.mods.toml` 中将 `registratelib` 声明为必需依赖：  
 Then declare `registratelib` as a required dependency in your `neoforge.mods.toml`:
 
 ```toml
@@ -116,4 +150,21 @@ ordering="AFTER"
 side="BOTH"
 ```
 
-If you intentionally embed the library instead of loading it as a separate mod, keep your packaging and metadata strategy explicit so downstream debugging still has a clear ownership boundary.
+---
+
+## 开发指南 / Development
+
+- 使用 `Java 25` 进行本地构建和 IDE 同步 / Use `Java 25` for local builds and IDE sync
+- 优先使用捆绑的 IDEA 运行配置：`Client`、`Server`、`Data Generation`、`Game Tests`、`Game Tests (Client)`
+  Prefer the bundled IDEA run configurations
+- 流式注册 API 放在 `builders`，数据生成编排放在 `providers`，公开辅助工具放在 `util`，实现细节放在 `internal`
+  Keep fluent registration APIs in `builders`, data generation orchestration in `providers`, public reusable helpers in `util`, and implementation plumbing in `internal`
+- 查看 [`docs/architecture.md`](docs/architecture.md) 了解包职责和扩展点
+  See [`docs/architecture.md`](docs/architecture.md) for package responsibilities and extension points
+
+---
+
+## 贡献 / Contributing
+
+请阅读 [`CONTRIBUTING.md`](CONTRIBUTING.md) 了解如何为此项目做出贡献。  
+Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on how to contribute to this project.