lms
db0143be83
- Resolve directory rename conflict from old 03/06 dirs - Move remote-added 资源加载重构方案.md into modules/frameworks/资源管理/ - Move remote-added 06_工具脚本/MCP工具 into modules/frameworks/编辑器工具/MCP工具/ - Keep Tools/CodexUnityMcp/ as MCP Server implementation - Update README.md, modules/模块索引.md, and parent READMEs - Add 文档关联 sections to new docs and fix old absolute paths Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
88 lines
5.1 KiB
Markdown
88 lines
5.1 KiB
Markdown
# 模块索引
|
||
|
||
这里是 UnityAI / StrayFog 框架知识库的项目知识总入口。
|
||
|
||
模块清单、模块状态和模块入口以本文件为准；`rules/` 只维护规则和约束，不重复维护模块事实表。
|
||
|
||
---
|
||
|
||
## 重要口径
|
||
|
||
- **核心框架**：支撑游戏运行的内部系统，例如实体系统、UI 窗口系统、事件系统、资源管理、对象池、场景管理。
|
||
- **编辑器工具**：Unity Editor 内使用的生成器、Inspector、菜单、配置工具。
|
||
- **业务参考**：外部实际项目的业务实现示例，仅作参考，不作为框架规范。见 [business-reference](../business-reference/playballoons/业务参考总入口.md)。
|
||
|
||
轻量模块先在本文件登记；复杂模块再拆独立目录。
|
||
|
||
---
|
||
|
||
## 状态口径
|
||
|
||
见 [模块登记规则](../rules/30-模块登记规则.md#状态定义)。
|
||
|
||
不要使用“已开始”，优先使用“已识别 / 初步梳理 / 待验证 / 已完成 / 未发现实现”。
|
||
|
||
---
|
||
|
||
## 核心框架
|
||
|
||
| 框架模块 | 主要路径 | 当前判断 | 状态 |
|
||
|---|---|---|---|
|
||
| [模拟行为系统](frameworks/通用框架/README.md) | `Assets/StrayFog/Core/SimulateBehaviour/` | 解耦 MonoBehaviour，模拟完整生命周期 | 已完成 |
|
||
| [对象池](frameworks/内存对象管理/README.md) | `Assets/Game/GameHFScripte/CopyToHF/MemoryManager/` | GameObject 对象池、脚本对象池、类实例池 | 已完成 |
|
||
| [事件系统](frameworks/事件系统/README.md) | `Assets/Game/GameHFScripte/CopyToHF/Event/` | CTC/STC 事件参数和事件派发 | 已完成 |
|
||
| [资源管理](frameworks/资源管理/README.md) | `Assets/Game/GameHFScripte/CopyToHF/AssetBundle/` | AssetBundle、语言资源、图集、加载规则；含 [资源加载重构方案](frameworks/资源管理/资源加载重构方案.md) | 已完成 |
|
||
| [相机系统](frameworks/相机系统/README.md) | `Assets/Game/GameHFScripte/CopyToHF/` | 多相机管理、相机堆栈、渲染顺序 | 初步梳理 |
|
||
| [实体系统](frameworks/实体系统/README.md) | `Assets/Game/GameHFScripte/GameFunction/GameEntity/` | 实体基类、模型/系统、实体池 | 已完成 |
|
||
| [UI 窗口系统](frameworks/UI窗口系统/README.md) | `Assets/Game/GameHFScripte/CopyToHF/UIWindowMgr/` | UI 窗口管理、窗口基类、生命周期 | 已完成 |
|
||
| [技能系统](frameworks/技能系统/README.md) | `Assets/Game/GameHFScripte/GameFunction/GameEntity/` | 技能触发器、释放器、配置联动 | 初步梳理 |
|
||
| [场景系统](frameworks/场景系统.md) | `Assets/Game/GameHFScripte/GameFunction/SceneManager/` | 场景加载、资源配置、生命周期 | 初步梳理 |
|
||
| [网络系统](frameworks/网络系统.md) | `Assets/Game/GameHFScripte/CopyToHF/Network/` | WebSocket、protobuf、消息映射 | 初步梳理 |
|
||
| [配置生成](frameworks/数据配置框架.md) | `XLSX_SRC/`、`Assets/AutoBuildScript/` | 表格配置源、解析、生成代码 | 初步梳理 |
|
||
| [Hotfix 启动](frameworks/Hotfix启动.md) | `Assets/Game/GameHFScripte/GameFunction/GameRoot/` | hotfix 侧根入口和功能目录聚合 | 初步梳理 |
|
||
|
||
---
|
||
|
||
## 编辑器工具
|
||
|
||
| 工具模块 | 主要路径 | 当前判断 | 状态 |
|
||
|---|---|---|---|
|
||
| [SF Editor](frameworks/编辑器工具/README.md#sf-editor) | `Assets/StrayFog/Editor/` | StrayFog 编辑器扩展 | 待验证 |
|
||
| [项目 Editor Assets](frameworks/编辑器工具/README.md#project-editor-assets) | `Assets/Editor/` | 项目编辑器资源与脚本 | 待验证 |
|
||
| [UI 拼接工具](frameworks/编辑器工具/UI拼接工具.md) | `Assets/Editor/Command/` | UI 预制体 JSON 双向转换 | 待验证 |
|
||
| [MCP 工具](frameworks/编辑器工具/MCP工具/README.md) | `Tools/CodexUnityMcp/` | Codex ↔ Unity Editor MCP | 待验证 |
|
||
|
||
---
|
||
|
||
## 文档拆分规则
|
||
|
||
- 核心框架按技术职责命名，可以对应 `GameEntity`、`UIWindowMgr`、`Network`、`AssetBundle`、`Event` 这类内部系统。
|
||
- 轻量模块只在本文件登记。
|
||
- 复杂模块再拆 `modules/<module>/`。
|
||
- `模块索引.md` 写稳定说明。
|
||
- `progress.md` 写阶段状态。
|
||
- `tasks.md` 写下一步待办。
|
||
- 跨模块计划放到 [plans](../plans/)。
|
||
|
||
---
|
||
|
||
## 相关文档
|
||
|
||
- [项目规则入口](../rules/项目规则入口.md)：AI 工作方式、扫描范围、归档规则和规则索引。
|
||
- [模块登记规则](../rules/30-模块登记规则.md)：分类口径、状态定义和新增模块登记规则。
|
||
- [架构说明](../rules/10-架构说明.md)：总体分层、程序集边界和依赖方向。
|
||
|
||
---
|
||
|
||
## 文档关联
|
||
|
||
> 当本文档发生变更时，应同步检查以下关联文档，避免信息不一致。
|
||
|
||
| 文档 | 关联原因 |
|
||
|---|---|
|
||
| [rules/30-模块登记规则.md](../rules/30-模块登记规则.md) | 模块索引是模块登记规则的唯一事实来源 |
|
||
| [rules/10-架构说明.md](../rules/10-架构说明.md) | 模块分类、分层与架构说明互相影响 |
|
||
| [rules/项目规则入口.md](../rules/项目规则入口.md) | 模块索引是项目规则入口引用的项目知识总入口 |
|
||
| [ai/AI接入入口.md](../ai/AI接入入口.md) | AI 接入入口引用模块索引作为必读文档 |
|
||
| [modules/frameworks/*](frameworks/) | 框架模块文档新增/拆分时需同步索引 |
|