Shiliang/UnityAI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构

Browse Source 
- 删除 01~05 旧中文教程目录
- 将 03 核心功能教程拆分为各 framework 模块的子文档
- 06 工具脚本移入 modules/frameworks/编辑器工具/UI工具/
- 非框架内容合并进 rules/20-开发规则.md 与 rules/40-工作流清单.md
- 更新所有交叉链接与文档关联表

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
lms
2026-07-07 18:36:15 +08:00
parent 5e5b9f8c80
commit ee1ff7f444
77 changed files with 6263 additions and 1133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
README.md
View File

@@ -1,40 +1,73 @@
# UnityAI - StrayFog框架文档中心
# UnityAI - StrayFog 框架文档中心
## 📋 文档索引
本仓库是 **StrayFog 框架的知识库**，同时服务两类读者：
### 01_框架架构
- [StrayFog框架架构分析](01_框架架构/StrayFog框架架构分析.md)
- **人工开发者**：通过 `modules/frameworks/` 下的框架模块文档和 `rules/` 下的规则文档学习使用 StrayFog 框架。
- **AI 工具**：通过 `ai/`、`rules/`、`modules/`、`hooks/` 下的规则、模块、hook 文档快速理解框架结构和工作方式。
### 02_开发规范
- [开发规范指南](02_开发规范/开发规范指南.md)
---
### 03_核心功能
- [对象池使用指南](03_核心功能/对象池使用指南.md)
- [事件系统使用指南](03_核心功能/事件系统使用指南.md)
- [资源管理使用指南](03_核心功能/资源管理使用指南.md)
- [相机系统使用指南](03_核心功能/相机系统使用指南.md)
## 🚀 快速入口
#### Entity相关
- [Entity开发指南](03_核心功能/Entity/Entity开发指南.md) - Entity创建规范、生命周期、System-Model架构、属性系统、对象池
- [UnityEntities注意事项](03_核心功能/Entity/UnityEntities注意事项.md) - 枚举定义、ESM架构、数据表字段映射、动画系统、AI系统、错误处理、架构模式
- [通用技能系统使用指南](03_核心功能/Entity/通用技能系统使用指南.md) - 通用技能系统架构、使用方法、配置管理、事件系统
| 读者 | 入口 |
|------|------|
| AI 工具 | [AGENTS.md](AGENTS.md) / [CLAUDE.md](CLAUDE.md) / [RULES.md](RULES.md) → [ai/AI接入入口.md](ai/AI接入入口.md) |
| 人工开发者 | 继续阅读下方中文文档索引 |
#### UI相关
- [UI开发指南](03_核心功能/UI/UI开发指南.md) - 窗口开发、组件使用、事件绑定、对象池、开发规范
- [UI界面拼接设计指南](03_核心功能/UI/UI界面拼接设计指南.md) - 界面模块化设计、布局规划、模块组装
---
### 04_开发流程
- [开发流程指南](04_开发流程/开发流程指南.md)
- [最佳实践指南](04_开发流程/最佳实践指南.md)
- [常见问题指南](04_开发流程/常见问题指南.md)
## 🤖 AI 工具说明
### 05_项目管理
- [核心库保护规范](05_项目管理/核心库保护规范.md)
- [Git规定指南](05_项目管理/Git规定指南.md)
- [Git提交注意事项](05_项目管理/Git提交注意事项.md)
处理本仓库任务时，AI 工具应：
### 06_工具脚本
- [UI工具](06_工具脚本/UI工具/) - UI预制体与JSON双向转换工具
1. 读取 [ai/AI接入入口.md](ai/AI接入入口.md)
2. 读取 [rules/项目规则入口.md](rules/项目规则入口.md)
3. 按需读取 [modules/模块索引.md](modules/模块索引.md) 中的框架模块
4. 如需了解外部项目业务参考，读取 [business-reference/playballoons/业务框架映射接口.md](business-reference/playballoons/业务框架映射接口.md)
---
## 📋 中文文档索引
### 框架架构
- [通用框架](modules/frameworks/通用框架/README.md) — General/StrayFog Core 通用能力
- [框架架构分析](modules/frameworks/通用框架/框架架构.md) — StrayFog 整体架构分析
### 核心框架
- [实体系统](modules/frameworks/实体系统/README.md)
- [Entity 开发指南](modules/frameworks/实体系统/开发指南.md)
- [Unity Entities 注意事项](modules/frameworks/实体系统/注意事项.md)
- [技能系统](modules/frameworks/技能系统/README.md)
- [通用技能系统使用指南](modules/frameworks/技能系统/使用指南.md)
- [UI 窗口系统](modules/frameworks/UI窗口系统/README.md)
- [UI 开发指南](modules/frameworks/UI窗口系统/开发指南.md)
- [UI 界面拼接设计指南](modules/frameworks/UI窗口系统/界面拼接.md)
- [事件系统](modules/frameworks/事件系统/README.md)
- [事件系统使用指南](modules/frameworks/事件系统/使用指南.md)
- [对象池与运行时对象管理](modules/frameworks/内存对象管理/README.md)
- [对象池使用指南](modules/frameworks/内存对象管理/使用指南.md)
- [相机系统](modules/frameworks/相机系统/README.md)
- [相机系统使用指南](modules/frameworks/相机系统/使用指南.md)
- [资源管理](modules/frameworks/资源管理/README.md)
- [资源管理使用指南](modules/frameworks/资源管理/使用指南.md)
- [场景系统](modules/frameworks/场景系统.md)
- [网络系统](modules/frameworks/网络系统.md)
- [数据配置框架](modules/frameworks/数据配置框架.md)
- [Hotfix 启动](modules/frameworks/Hotfix启动.md)
- [第三方插件](modules/frameworks/第三方插件.md)
### 编辑器工具
- [编辑器工具](modules/frameworks/编辑器工具/README.md)
- [UI 拼接工具](modules/frameworks/编辑器工具/UI拼接工具.md)
### 项目规则
- [项目规则入口](rules/项目规则入口.md)
- [架构说明](rules/10-架构说明.md)
- [开发规则](rules/20-开发规则.md)
- [工作流清单](rules/40-工作流清单.md)
### 编辑器工具脚本
- [UI 工具](modules/frameworks/编辑器工具/UI工具/) — UI 预制体与 JSON 双向转换工具
---
@@ -42,12 +75,32 @@
| 场景 | 推荐文档 |
|-----|---------|
| 新人开发 | `02_开发规范/开发规范指南.md` |
| 使用对象池 | `03_核心功能/对象池使用指南.md` |
| 使用事件系统 | `03_核心功能/事件系统使用指南.md` |
| 遇到问题 | `04_开发流程/常见问题指南.md` |
| 新人开发 | [开发规则](rules/20-开发规则.md) |
| 使用对象池 | [对象池与运行时对象管理](modules/frameworks/内存对象管理/README.md) |
| 使用事件系统 | [事件系统](modules/frameworks/事件系统/README.md) |
| 遇到问题 | [开发规则/常见问题](rules/20-开发规则.md#常见问题) |
| AI 工具接入 | [ai/AI接入入口.md](ai/AI接入入口.md) |
---
## 📦 业务参考
- [business-reference/playballoons/](business-reference/playballoons/) — 来自 PlayBalloons 实际项目的业务参考，与 StrayFog 框架核心分离。
---
## 文档关联
> 当本文档发生变更时，应同步检查以下关联文档，避免信息不一致。
| 文档 | 关联原因 |
|---|---|
| [ai/AI接入入口.md](ai/AI接入入口.md) | AI 工具入口说明 |
| [rules/项目规则入口.md](rules/项目规则入口.md) | 项目规则总入口 |
| [modules/模块索引.md](modules/模块索引.md) | 框架模块索引 |
| [rules/00-项目概览.md](rules/00-项目概览.md) | 项目概览中的人工开发者使用方式 |
---
**版本**: v1.0
**适用项目**: GiftGameX
**适用项目**: GiftGameX