lms
fc23b75e95
- 通用框架分类由项目框架改为核心框架 - 模块索引补录第三方插件并校准各模块状态 - 项目规则入口声明核心规则完整定义 - 20/40 规则文档中重复 Git 规则改为链接引用 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
65 lines
3.5 KiB
Markdown
65 lines
3.5 KiB
Markdown
# UnityAI 项目规则入口
|
||
|
||
UnityAI 是 StrayFog 框架的通用工作流与知识标准。具体游戏项目负责提供真实代码、资源和验证环境；当前主要验证对象为 `CrystalBattle_Client`。
|
||
|
||
## 快速启动
|
||
|
||
处理任务时按顺序执行：
|
||
|
||
1. 读取本文件和 [工作流清单](40-工作流清单.md)。
|
||
2. 从 [模块索引](../modules/模块索引.md) 读取相关模块文档。
|
||
3. 检查 UnityAI 与目标 Unity 项目的 Git 状态，保留已有修改。
|
||
4. 根据 [架构说明](10-架构说明.md) 找到真实源码，区分源码、生成代码、业务代码和资源。
|
||
5. 按任务类型分析、修改、生成和验证。
|
||
6. 按 [文档同步规则](50-文档同步规则.md) 判断是否需要更新长期文档。
|
||
|
||
## 工作方式
|
||
|
||
- **分析检查**：读取代码、Prefab、配置或日志，给出有证据的结论，不修改文件。
|
||
- **局部修复**：影响范围明确时直接修复并完成针对性验证。
|
||
- **重大变更**：涉及公共接口、框架、生成流程、跨模块数据或批量迁移时，先在对话中确认目标、影响和实现方式，再修改。
|
||
- 重大变更的讨论和长期结论保存方式以 [工作流清单](40-工作流清单.md) 为准。
|
||
|
||
完整步骤与验收条件统一维护在 [工作流清单](40-工作流清单.md)，本文件不重复展开。
|
||
|
||
## 关键约束
|
||
|
||
以下约束为项目级核心规则的完整定义，其他规则文档只保留链接或一句话摘要。
|
||
|
||
- 先定位源码再修改，禁止把生成目录当作源码。
|
||
- `ESF_` 框架修改发生在 `Assets/StrayFog/Editor/CopyToX`，随后通过 CopyToX 生成 `HF_` 代码。
|
||
- 不直接手改 `Assets/Game/GameHFScripte/CopyToHF`。
|
||
- 业务代码通过项目公开入口使用框架；维护框架时修改真实框架源码。
|
||
- Prefab/UI 修改必须同时核对脚本、层级、RectTransform、组件状态和实际显示。
|
||
- Unity、平台和网络相关逻辑不能只凭 Editor 编译结果判断正确。
|
||
- 只在用户明确要求提交或推送时执行 Git 写操作；UnityAI 与游戏项目分别提交。
|
||
- 不覆盖、不回退任务开始前已有的修改或未跟踪文件。
|
||
|
||
## 规则索引
|
||
|
||
| 文档 | 用途 |
|
||
|---|---|
|
||
| [项目概览](00-项目概览.md) | UnityAI 定位、目录与读者 |
|
||
| [架构说明](10-架构说明.md) | 代码分层、源码边界和依赖方向 |
|
||
| [开发规则](20-开发规则.md) | C#、Unity、资源和生成代码规范 |
|
||
| [模块登记规则](30-模块登记规则.md) | 模块分类、状态与文档结构 |
|
||
| [工作流清单](40-工作流清单.md) | 唯一的任务执行流程 |
|
||
| [文档同步规则](50-文档同步规则.md) | 长期文档更新条件和方法 |
|
||
| [AI 工具扫描范围](70-AI工具扫描范围.md) | 扫描范围和忽略目录 |
|
||
|
||
## 知识入口
|
||
|
||
- [模块索引](../modules/模块索引.md)：框架、编辑器工具和使用文档入口。
|
||
- [共享检查](../hooks/Hook共享层.md)：工作流和提交检查脚本。
|
||
- `business-reference/`：外部业务项目案例，只作参考，不作为框架规范。
|
||
|
||
## 文档关联
|
||
|
||
| 文档 | 关联原因 |
|
||
|---|---|
|
||
| [AI 接入入口](../ai/AI接入入口.md) | AI 工具通过该入口进入本规则 |
|
||
| [工作流清单](40-工作流清单.md) | 任务执行流程的唯一事实来源 |
|
||
| [文档同步规则](50-文档同步规则.md) | 任务完成后的长期知识同步规则 |
|
||
| [模块索引](../modules/模块索引.md) | 项目知识入口 |
|
||
| [共享检查](../hooks/Hook共享层.md) | 规则的脚本化检查入口 |
|