2.5 KiB
2.5 KiB
AI 工具接入入口
本文件是 Codex、Claude Code、Cursor、Windsurf、GitHub Copilot 等工具进入 UnityAI 的统一入口。根目录 AGENTS.md、CLAUDE.md 和 RULES.md 只负责跳转,不复制项目规则。
读取顺序
随后读取目标 Unity 项目的真实代码、Prefab、配置、项目版本和 Git 状态。UnityAI 是通用标准,具体工程是实现和验证依据。
文档分层
| 层级 | 位置 | 用途 |
|---|---|---|
| AI 接入 | ai/AI接入入口.md |
工具如何进入工作流 |
| 项目规则 | rules/ |
架构、开发、工作流、文档同步和扫描范围 |
| 框架知识 | modules/ |
模块职责、API、数据流和验证方式 |
| 业务参考 | business-reference/ |
外部项目案例,不定义框架标准 |
| 共享检查 | hooks/ |
只读工作流检查和提交检查 |
| 可执行工具 | Tools/ |
MCP Server 等工具实现 |
重大变更的确认和长期文档落盘方式统一遵循 工作流清单。
工具接入原则
- 工具专属入口只链接本文件,不复制
rules/或modules/内容。 - 只有用户明确要求提交或推送时才执行 Git 写操作。
- UnityAI 与目标 Unity 项目分别检查、验证和提交。
- 任务结束时运行只读工作流检查:
powershell -NoProfile -ExecutionPolicy Bypass -File hooks/workflow-check.ps1 `
-UnityProjectRoot <Unity工程路径>
- 检查脚本只给出状态、生成边界、验证和文档建议,不自动写文件。
接入新工具
- 确认工具自动读取的入口文件。
- 在入口文件中链接本文件。
- 如支持任务结束命令,调用
hooks/workflow-check.ps1。 - 不在工具私有目录维护项目规则副本。
文档关联
| 文档 | 关联原因 |
|---|---|
| AGENTS.md | Codex 入口 |
| CLAUDE.md | Claude Code 入口 |
| RULES.md | 通用兼容入口 |
| 项目规则入口 | 项目规则总入口 |
| 工作流清单 | 唯一任务流程 |
| 模块索引 | 项目知识入口 |
| 共享检查 | 脚本入口 |