来源:
AGENTS.md
ai/project-map.yml
ai/test-matrix.yml
ai/generated-files.yml
commit d32b9cc880a8
docs-explanation
项目地图¶
项目地图回答三个问题:应该改哪里、哪里不能顺手改、改完运行什么验证。根
AGENTS.md 提供离线最小地图,ai/project-map.yml 和 ai/test-matrix.yml 提供
机器可读版本。
主要区域¶
| 路径 | 责任 | 下一步 |
|---|---|---|
src/ |
C++ 引擎、游戏逻辑、UI、原生 Lua 注册 | 读取 src/AGENTS.md 与相关测试 |
data/json/、data/core/ |
核心 JSON 定义 | 检查稳定 ID、格式和加载 |
data/lua/、tools/lua_api/ |
Lua 契约、声明、清单和示例 | 读取 data/lua/AGENTS.md |
data/mods/ |
随游戏发布的独立 MOD | 读取本 MOD 的 README 和依赖 |
tests/ |
Catch2 回归与集成测试 | 添加聚焦、可复现的行为测试 |
tools/ |
格式化器、验证器、生成器 | 保持 CLI 稳定并提供 --check |
android/ |
Android Gradle、Java UI 与打包 | 不提交 SDK、签名或 APK |
.github/、构建文件 |
CI、构建和发布契约 | 使用最小权限和固定 Action SHA |
跟踪一个行为¶
- 从可观察行为、JSON ID、动作名、测试名或日志文本开始。
- 使用
rg找定义与引用,不按目录顺序阅读整个源码树。 - 找到注册点、调用者、数据加载器和现有测试。
- 检查
ai/generated-files.yml,避免手改生成文件。 - 从测试矩阵选择最小充分验证。
边界¶
项目地图是导航,不是运行时规范。源码和测试决定行为;Schema、LuaLS、注册和 生成清单决定 API 契约;构建文件和 CI 决定构建行为。导航与这些事实冲突时, 应修复地图或本文并标记 stale。