Shiliang/UnityAI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
db0143be83a2e77cfd3079566e73d3882940e7d4
UnityAI/README.md

109 lines
4.6 KiB
Markdown
Raw Normal View History

[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
# UnityAI - StrayFog 框架文档中心
【重构】整理文档目录结构，创建5个分类文件夹，拆分业务开发指南为8个独立文档，添加README入口导航
2026-05-22 10:41:34 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
本仓库是 **StrayFog 框架的知识库**，同时服务两类读者：
【重构】整理文档目录结构，创建5个分类文件夹，拆分业务开发指南为8个独立文档，添加README入口导航
2026-05-22 10:41:34 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
- **人工开发者**：通过 `modules/frameworks/` 下的框架模块文档和 `rules/` 下的规则文档学习使用 StrayFog 框架。
- **AI 工具**：通过 `ai/`、`rules/`、`modules/`、`hooks/` 下的规则、模块、hook 文档快速理解框架结构和工作方式。
【重构】整理文档目录结构，创建5个分类文件夹，拆分业务开发指南为8个独立文档，添加README入口导航
2026-05-22 10:41:34 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
---
## 🚀 快速入口
| 读者 | 入口 |
|------|------|
| AI 工具 | [AGENTS.md](AGENTS.md) / [CLAUDE.md](CLAUDE.md) / [RULES.md](RULES.md) → [ai/AI接入入口.md](ai/AI接入入口.md) |
| 人工开发者 | 继续阅读下方中文文档索引 |
---
## 🤖 AI 工具说明
处理本仓库任务时，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)
---
【重构】整理文档目录结构，创建5个分类文件夹，拆分业务开发指南为8个独立文档，添加README入口导航
2026-05-22 10:41:34 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
## 📋 中文文档索引
整理UI文档：创建UI文件夹，更新README
2026-05-22 16:58:41 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
### 框架架构
- [通用框架](modules/frameworks/通用框架/README.md) — General/StrayFog Core 通用能力
- [框架架构分析](modules/frameworks/通用框架/框架架构.md) — StrayFog 整体架构分析
【新增】创建Entity文件夹及Entity开发指南文档，包含Entity分类、创建规范、生命周期、System-Model架构、属性系统、对象池等内容
2026-05-29 15:01:50 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
### 核心框架
- [实体系统](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)
Merge remote changes: integrate MCP tools and resource refactor docs into framework - 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>
2026-07-07 19:07:27 +08:00
- [资源加载重构方案](modules/frameworks/资源管理/资源加载重构方案.md)
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
- [场景系统](modules/frameworks/场景系统.md)
- [网络系统](modules/frameworks/网络系统.md)
- [数据配置框架](modules/frameworks/数据配置框架.md)
- [Hotfix 启动](modules/frameworks/Hotfix启动.md)
- [第三方插件](modules/frameworks/第三方插件.md)
【更新】优化UI文档结构，组合UI开发文档为整体，修正窗口打开方式
2026-05-22 11:21:57 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
### 编辑器工具
- [编辑器工具](modules/frameworks/编辑器工具/README.md)
- [UI 拼接工具](modules/frameworks/编辑器工具/UI拼接工具.md)
Merge remote changes: integrate MCP tools and resource refactor docs into framework - 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>
2026-07-07 19:07:27 +08:00
- [MCP 工具](modules/frameworks/编辑器工具/MCP工具/README.md)
【重构】整理文档目录结构，创建5个分类文件夹，拆分业务开发指南为8个独立文档，添加README入口导航
2026-05-22 10:41:34 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
### 项目规则
- [项目规则入口](rules/项目规则入口.md)
- [架构说明](rules/10-架构说明.md)
- [开发规则](rules/20-开发规则.md)
- [工作流清单](rules/40-工作流清单.md)
【重构】整理文档目录结构，创建5个分类文件夹，拆分业务开发指南为8个独立文档，添加README入口导航
2026-05-22 10:41:34 +08:00
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
### 编辑器工具脚本
- [UI 工具](modules/frameworks/编辑器工具/UI工具/) — UI 预制体与 JSON 双向转换工具
feat(tools): 添加UI工具脚本及部署文档 新增内容： 1. 创建 06_工具脚本/UI工具/ 目录，包含4个核心工具脚本 - ExternalCommandListener.cs - 外部命令监听器 - RemoteCommand.cs - 远程命令接口 - UIPrefabGenerator.cs - JSON转预制体生成器 - UIPrefabToJson.cs - 预制体转JSON导出器 2. 更新 UI界面拼接设计指南.md - 新增8.9节工具脚本部署说明 - 包含手动部署和自动部署两种方式 - 添加部署规则和验证步骤 3. 更新 README.md - 添加06_工具脚本章节索引 部署方法： - 手动复制：复制工具脚本到项目 Assets/Editor/Command/ 目录 - 自动部署：使用 DeployUITools.bat 脚本
2026-05-27 15:56:18 +08:00
【重构】整理文档目录结构，创建5个分类文件夹，拆分业务开发指南为8个独立文档，添加README入口导航
2026-05-22 10:41:34 +08:00
---
## 🎯 快速入门
| 场景 | 推荐文档 |
|-----|---------|
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
| 新人开发 | [开发规则](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) | 项目概览中的人工开发者使用方式 |
【重构】整理文档目录结构，创建5个分类文件夹，拆分业务开发指南为8个独立文档，添加README入口导航
2026-05-22 10:41:34 +08:00
---
**版本**: v1.0
[docs][refactor]: 将旧 01~06 中文教程合并整理为 modules/frameworks 文件夹结构 - 删除 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>
2026-07-07 18:36:15 +08:00
**适用项目**: GiftGameX
Reference in New Issue Copy Permalink