61 lines
4.6 KiB
Markdown
61 lines
4.6 KiB
Markdown
# 模块索引
|
||
|
||
这里是 UnityAI / StrayFog 框架知识总入口。模块入口和状态以本文件为准，状态定义见 [模块登记规则](../rules/30-模块登记规则.md)。
|
||
|
||
## 核心框架
|
||
|
||
| 模块 | 主要路径 | 职责 | 状态 |
|
||
|---|---|---|---|
|
||
| [通用框架](frameworks/通用框架/README.md) | `Assets/StrayFog/Core/`、`GameGeneralScripte/` | 模拟行为、全局数据和通用工具 | 已完成 |
|
||
| [对象池](frameworks/内存对象管理/README.md) | `CopyToHF/MemoryManager/` | GameObject、脚本和类实例池 | 已完成 |
|
||
| [事件系统](frameworks/事件系统/README.md) | `CopyToHF/Event/` | CTC/STC 事件派发 | 已完成 |
|
||
| [资源管理](frameworks/资源管理/README.md) | `CopyToHF/AssetBundle/`、`StrayFog/Core/SFSubPackageV2.cs` | AssetBundle、图集、卸载、分包 V2 和下载 | 已完成 |
|
||
| [微信小游戏资源接入方案](frameworks/资源管理/微信小游戏资源接入方案.md) | `CopyToGeneral/MinGameModel/`、`SFSubPackageV2.cs` | FFCard_WeChat 微信 CDN、缓存、加载、卸载和资源生命周期接入方案 | 待实施 |
|
||
| [微信小游戏渲染规则](frameworks/微信小游戏渲染规则.md) | `ProjectSettings/`、URP Asset、Shader、Shader Graph、材质 | WebGL 2、URP、Shader 变体、透明深度、纹理与微信真机渲染规范 | 待验证 |
|
||
| [音效系统重构方案](frameworks/音效系统重构方案.md) | `StrayFog/Editor/CopyToX/CopyToHF/Audio/`、`CopyToGeneral/Audio/` | 原生音频播放、混音、缓存、并发与资源生命周期设计 | 待验证 |
|
||
| [相机系统](frameworks/相机系统/README.md) | `GameHFScripte/` | 多相机、堆栈和渲染顺序 | 已完成 |
|
||
| [实体系统](frameworks/实体系统/README.md) | `GameFunction/GameEntity/` | 实体、System、Model 和实体池 | 已完成 |
|
||
| [UI 窗口系统](frameworks/UI窗口系统/README.md) | `CopyToHF/UIWindowMgr/`、`GameFunction/UIWindows/` | 窗口生命周期、加载、卸载和列表 | 已完成 |
|
||
| [技能系统](frameworks/技能系统/README.md) | `GameFunction/GameEntity/` | 技能触发、释放和配置联动 | 已完成 |
|
||
| [场景系统](frameworks/场景系统.md) | `GameFunction/SceneManager/` | 场景加载和生命周期 | 待验证 |
|
||
| [网络系统](frameworks/网络系统.md) | `CopyToHF/Network/`、`GameFunction/WebSocket/` | WebSocket、protobuf 和消息映射 | 待验证 |
|
||
| [数据配置](frameworks/数据配置框架.md) | 项目表格、proto 和生成目录 | 配置源、解析和代码生成 | 待验证 |
|
||
| [Hotfix 启动](frameworks/Hotfix启动.md) | `GameFunction/GameRoot/`、`GameDllManager` | AOT、热更 DLL 和业务入口 | 待验证 |
|
||
|
||
## 项目框架
|
||
|
||
| 模块 | 主要路径 | 职责 | 状态 |
|
||
|---|---|---|---|
|
||
| [第三方插件](frameworks/第三方插件.md) | `Assets/ThirdPlugins/`、`Packages/` | 记录 HybridCLR、Spine、DOTween 等插件用途、边界、本地修改和升级风险 | 已识别 |
|
||
|
||
## 编辑器工具
|
||
|
||
| 模块 | 主要路径 | 职责 | 状态 |
|
||
|---|---|---|---|
|
||
| [SF Editor](frameworks/编辑器工具/README.md#sf-editor) | `Assets/StrayFog/Editor/` | StrayFog 生成器和 Editor 扩展 | 已完成 |
|
||
| [项目 Editor Assets](frameworks/编辑器工具/README.md#project-editor-assets) | `Assets/Editor/` | 项目级 Editor 工具 | 已识别 |
|
||
| [UI 拼接工具](frameworks/编辑器工具/UI拼接工具.md) | `Assets/Editor/Command/` | UI Prefab 与 JSON 双向转换 | 已完成 |
|
||
| [MCP 工具](frameworks/编辑器工具/MCP工具/README.md) | `Tools/CodexUnityMcp/`、Unity Bridge | Codex 与 Unity Editor 工具桥 | 已完成 |
|
||
|
||
## 业务参考
|
||
|
||
- [PlayBalloons](../business-reference/playballoons/业务参考总入口.md)：外部项目业务实现示例，不作为框架规范。
|
||
- [FFCard_WeChat 卡牌 Shader 框架](../business-reference/ffcard-wechat/卡牌Shader框架.md)：GameHFResource 内的 URP 卡牌 Shader 与 Y 轴深度业务实现，不作为通用核心框架。
|
||
|
||
## 文档拆分
|
||
|
||
- 轻量模块只保留 README。
|
||
- 公共 API 较多时增加使用指南或开发指南。
|
||
- 特殊限制较多时增加注意事项。
|
||
- 一次性任务不扩展模块文档结构，具体规则见 [工作流清单](../rules/40-工作流清单.md)。
|
||
|
||
## 文档关联
|
||
|
||
| 文档 | 关联原因 |
|
||
|---|---|
|
||
| [模块登记规则](../rules/30-模块登记规则.md) | 分类、状态和拆分规则 |
|
||
| [架构说明](../rules/10-架构说明.md) | 模块代码分层和源码边界 |
|
||
| [框架架构](frameworks/框架架构.md) | 全局实现视角的框架分层 |
|
||
| [项目规则入口](../rules/项目规则入口.md) | 项目知识入口 |
|
||
| [AI 接入入口](../ai/AI接入入口.md) | AI 必读模块索引 |
|