Skip to content

Commit 6f05d39

Browse files
doc: 📝 docs: 补充CLAUDE.md跨数据包函数调用和本地化系统文档
1 parent 428cf06 commit 6f05d39

1 file changed

Lines changed: 22 additions & 4 deletions

File tree

CLAUDE.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
2020
- `:datapack` - 构建数据包 ZIP 文件
2121
- `:server` - 启动开发服务器别名
2222

23+
### 跨数据包函数调用
24+
25+
构建系统支持跨数据包函数调用展开机制:
26+
27+
- **自动展开**:当函数文件中包含 `function dfl:lib/xxx` 等跨数据包调用时,`process_mcfunction` 规则会自动展开为正确的目标数据包函数路径
28+
- **依赖感知**:展开机制基于数据包依赖关系,确保函数调用指向正确的目标数据包
29+
- **性能优化**:使用 Worker 协议进行高效处理,避免重复的构建开销
30+
2331
### 示例构建命令
2432

2533
```bash
@@ -60,12 +68,17 @@ bazelisk build //...
6068
- `minecraft/` - Minecraft 原生命名空间文件
6169
- `rule/` - Bazel 构建规则定义
6270
- `datapack.bzl` - 主要的数据包构建宏
63-
- `process_mcfunction.bzl` - 函数文件处理规则
71+
- `process_mcfunction.bzl` - 函数文件处理规则(支持跨数据包函数调用展开)
6472
- `process_json.bzl` - JSON 文件压缩规则
73+
- `merge_json.bzl` - JSON 文件合并规则(用于本地化系统)
6574
- `upload_modrinth.bzl` - Modrinth 上传规则
6675
- `repo/` - 外部依赖配置
6776
- `third_party/` - 第三方库集成
6877
- `template/` - 数据包模板文件
78+
- `game/` - 游戏相关资源
79+
- `Localization-Resource-Pack/` - 本地化资源包源文件(详见本地化系统部分)
80+
- `translate/` - 自动翻译输出目录(由 CI 自动生成)
81+
- `private/` - 私有配置(包含敏感信息,已加入 .gitignore)
6982

7083
### 数据包组件
7184

@@ -111,9 +124,14 @@ bazelisk build //...
111124

112125
- `pack_id` - 数据包命名空间 ID
113126
- `pack_version` - 数据包版本(必须符合 SemVer)
114-
- `game_versions` - 支持的 Minecraft 版本范围
127+
- `target_name` - 主要目标名称(默认为当前包名称)
128+
- `game_versions` - 支持的 Minecraft 版本列表(默认为 `minecraft_versions_range("1.20")`,即从 1.20 到最新版本的所有版本)
115129
- `modrinth_project_id` - Modrinth 项目 ID(可选)
116-
- `deps` - 依赖列表
130+
- `changelog` - 更新日志文件路径(默认为 `"NEWS.md"`
131+
- `version_type` - 版本类型:`"release"``"beta"``"alpha"`(默认为 `"release"`
132+
- `modrinth_deps` - Modrinth 依赖字典列表(默认为空列表)
133+
- `include_localization_dependency` - 是否自动包含本地化资源包作为依赖(默认为 `True`
134+
- `deps` - 传递给 `datapack` 规则的其他依赖参数(通过 `**kwargs`
117135

118136
### minecraft_versions_range
119137

@@ -162,7 +180,7 @@ bazelisk build //...
162180

163181
- 所有数据包都使用 GPL 许可证
164182
- 项目包含本地化资源包依赖
165-
- 构建系统会自动处理 JSON 文件压缩和函数文件扩展
183+
- 构建系统会自动处理 JSON 文件压缩、函数文件扩展和跨数据包函数调用展开
166184
- 开发服务器配置为 4GB 内存,可在 `datapack.bzl` 中调整
167185
- **提交消息要求**:所有提交消息**必须**包含更改项目的名称标记
168186
- **本地化注意事项**

0 commit comments

Comments
 (0)