[docs][fix]: 统一通用框架分类并补录第三方插件到模块索引

- 通用框架分类由项目框架改为核心框架
- 模块索引补录第三方插件并校准各模块状态
- 项目规则入口声明核心规则完整定义
- 20/40 规则文档中重复 Git 规则改为链接引用

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
lms
2026-07-15 14:35:48 +08:00
parent 001d9e5ef5
commit fc23b75e95
7 changed files with 20 additions and 13 deletions

View File

@@ -2,7 +2,7 @@
## 分类
- 项目框架
- 核心框架
## 目的

View File

@@ -10,20 +10,26 @@
| [对象池](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/相机系统/README.md) | `GameHFScripte/` | 多相机、堆栈和渲染顺序 | 初步梳理 |
| [相机系统](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/技能系统/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 扩展 | 初步梳理 |
| [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 工具桥 | 已完成 |
@@ -45,5 +51,6 @@
|---|---|
| [模块登记规则](../rules/30-模块登记规则.md) | 分类、状态和拆分规则 |
| [架构说明](../rules/10-架构说明.md) | 模块代码分层和源码边界 |
| [框架架构](frameworks/框架架构.md) | 全局实现视角的框架分层 |
| [项目规则入口](../rules/项目规则入口.md) | 项目知识入口 |
| [AI 接入入口](../ai/AI接入入口.md) | AI 必读模块索引 |

View File

@@ -67,7 +67,7 @@
- 验证范围随改动范围扩大,最低要求见 [工作流清单](40-工作流清单.md)。
- 编译通过后仍需检查 Unity ConsoleUI 和平台逻辑继续做实际运行验证。
- UnityAI 与目标 Unity 项目分别检查 Git 状态。
- 只有用户明确要求时才提交或推送,提交格式统一为 `[模块][类型]: 描述`
- Git 提交规则见 [项目规则入口](项目规则入口.md)
## 文档规则

View File

@@ -92,10 +92,8 @@ dotnet build GameHF.csproj --no-restore -v:minimal
### 8. Git
- 只有用户明确要求“提交”“commit”“推送”时才执行 Git 写操作
- UnityAI 和目标 Unity 项目是独立仓库,分别检查、暂存、提交和推送。
- Git 提交与推送规则见 [项目规则入口](项目规则入口.md)
- 提交前运行工作流检查、目标测试、`git diff --check` 和提交信息检查。
- 提交格式:`[模块][类型]: 描述`,类型为 `feat``fix``docs``refactor``test``chore`
- 不把两个仓库的改动描述成一个提交,也不夹带任务开始前的无关修改。
## 三、UI 专项流程

View File

@@ -24,6 +24,8 @@ UnityAI 是 StrayFog 框架的通用工作流与知识标准。具体游戏项
## 关键约束
以下约束为项目级核心规则的完整定义,其他规则文档只保留链接或一句话摘要。
- 先定位源码再修改,禁止把生成目录当作源码。
- `ESF_` 框架修改发生在 `Assets/StrayFog/Editor/CopyToX`,随后通过 CopyToX 生成 `HF_` 代码。
- 不直接手改 `Assets/Game/GameHFScripte/CopyToHF`
@@ -43,7 +45,7 @@ UnityAI 是 StrayFog 框架的通用工作流与知识标准。具体游戏项
| [模块登记规则](30-模块登记规则.md) | 模块分类、状态与文档结构 |
| [工作流清单](40-工作流清单.md) | 唯一的任务执行流程 |
| [文档同步规则](50-文档同步规则.md) | 长期文档更新条件和方法 |
| [项目设置](70-项目设置.md) | 扫描范围和忽略目录 |
| [AI 工具扫描范围](70-AI工具扫描范围.md) | 扫描范围和忽略目录 |
## 知识入口