【整合】 框架使用规则
This commit is contained in:
Shiliang
111
README.md
111
README.md
@@ -1,108 +1,69 @@
|
||||
# UnityAI - StrayFog 框架文档中心
|
||||
|
||||
本仓库是 **StrayFog 框架的知识库**，同时服务两类读者：
|
||||
UnityAI 是 StrayFog 框架的通用工作流与知识库。它面向 AI 工具、业务开发人员和框架维护人员；具体 Unity 项目提供真实实现与验证环境，当前主要验证对象为 `CrystalBattle_Client`。
|
||||
|
||||
- **人工开发者**：通过 `modules/frameworks/` 下的框架模块文档和 `rules/` 下的规则文档学习使用 StrayFog 框架。
|
||||
- **AI 工具**：通过 `ai/`、`rules/`、`modules/`、`hooks/` 下的规则、模块、hook 文档快速理解框架结构和工作方式。
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速入口
|
||||
## 快速入口
|
||||
|
||||
| 读者 | 入口 |
|
||||
|------|------|
|
||||
| AI 工具 | [AGENTS.md](AGENTS.md) / [CLAUDE.md](CLAUDE.md) / [RULES.md](RULES.md) → [ai/AI接入入口.md](ai/AI接入入口.md) |
|
||||
| 人工开发者 | 继续阅读下方中文文档索引 |
|
||||
|---|---|
|
||||
| Codex | [AGENTS.md](AGENTS.md) |
|
||||
| Claude Code | [CLAUDE.md](CLAUDE.md) |
|
||||
| 其他 AI / 人工 | [RULES.md](RULES.md) |
|
||||
| 项目工作流 | [工作流清单](rules/40-工作流清单.md) |
|
||||
| 框架知识 | [模块索引](modules/模块索引.md) |
|
||||
|
||||
---
|
||||
## 项目规则
|
||||
|
||||
## 🤖 AI 工具说明
|
||||
- [项目概览](rules/00-项目概览.md)
|
||||
- [架构说明](rules/10-架构说明.md)
|
||||
- [开发规则](rules/20-开发规则.md)
|
||||
- [模块登记规则](rules/30-模块登记规则.md)
|
||||
- [工作流清单](rules/40-工作流清单.md)
|
||||
- [文档同步规则](rules/50-文档同步规则.md)
|
||||
- [扫描范围](rules/70-项目设置.md)
|
||||
|
||||
处理本仓库任务时，AI 工具应：
|
||||
## 核心框架
|
||||
|
||||
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)
|
||||
- [实体系统](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/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)
|
||||
- [数据配置框架](modules/frameworks/数据配置框架.md)
|
||||
- [Hotfix 启动](modules/frameworks/Hotfix启动.md)
|
||||
- [第三方插件](modules/frameworks/第三方插件.md)
|
||||
|
||||
### 编辑器工具
|
||||
## 编辑器工具
|
||||
|
||||
- [编辑器工具](modules/frameworks/编辑器工具/README.md)
|
||||
- [UI 拼接工具](modules/frameworks/编辑器工具/UI拼接工具.md)
|
||||
- [MCP 工具](modules/frameworks/编辑器工具/MCP工具/README.md)
|
||||
- [UI 拼接工具](modules/frameworks/编辑器工具/UI拼接工具.md)
|
||||
- [MCP 工具](modules/frameworks/编辑器工具/MCP工具/README.md)
|
||||
- [CrystalBattle Codex 与 Unity MCP 使用规则](modules/frameworks/编辑器工具/MCP工具/CrystalBattle_Codex_Unity_MCP使用规则.md)
|
||||
|
||||
### 项目规则
|
||||
- [项目规则入口](rules/项目规则入口.md)
|
||||
- [架构说明](rules/10-架构说明.md)
|
||||
- [开发规则](rules/20-开发规则.md)
|
||||
- [工作流清单](rules/40-工作流清单.md)
|
||||
## 工作方式
|
||||
|
||||
### 编辑器工具脚本
|
||||
- [UI 工具](modules/frameworks/编辑器工具/UI工具/) — UI 预制体与 JSON 双向转换工具
|
||||
- UnityAI 定义通用标准，不把单个项目的业务实现写成框架强制规则。
|
||||
- 重大变更按 [工作流清单](rules/40-工作流清单.md) 在对话中确认，长期结论直接更新模块文档。
|
||||
- 公共接口、架构和稳定流程变化后，直接更新对应模块文档。
|
||||
- `ESF_` 框架源码通过 CopyToX 生成 `HF_` 代码，生成目录禁止手改。
|
||||
- Git 提交和推送只在用户明确要求时执行，文档仓库与 Unity 项目分别处理。
|
||||
|
||||
---
|
||||
## 业务参考
|
||||
|
||||
## 🎯 快速入门
|
||||
|
||||
| 场景 | 推荐文档 |
|
||||
|-----|---------|
|
||||
| 新人开发 | [开发规则](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 框架核心分离。
|
||||
|
||||
---
|
||||
- [PlayBalloons 业务参考](business-reference/playballoons/)：外部项目案例，不作为框架规范。
|
||||
|
||||
## 文档关联
|
||||
|
||||
> 当本文档发生变更时，应同步检查以下关联文档，避免信息不一致。
|
||||
|
||||
| 文档 | 关联原因 |
|
||||
|---|---|
|
||||
| [ai/AI接入入口.md](ai/AI接入入口.md) | AI 工具入口说明 |
|
||||
| [rules/项目规则入口.md](rules/项目规则入口.md) | 项目规则总入口 |
|
||||
| [modules/模块索引.md](modules/模块索引.md) | 框架模块索引 |
|
||||
| [rules/00-项目概览.md](rules/00-项目概览.md) | 项目概览中的人工开发者使用方式 |
|
||||
|
||||
---
|
||||
|
||||
**版本**: v1.0
|
||||
**适用项目**: GiftGameX
|
||||
| [AI 工具接入入口](ai/AI接入入口.md) | AI 工具统一入口 |
|
||||
| [项目规则入口](rules/项目规则入口.md) | 项目规则总入口 |
|
||||
| [模块索引](modules/模块索引.md) | 模块清单与状态 |
|
||||
| [项目概览](rules/00-项目概览.md) | UnityAI 定位与适用范围 |
|
||||
|
||||
Reference in New Issue
Block a user