For the complete documentation index, see llms.txt. This page is also available as Markdown.

受支持的编码代理

Convai Unity SDK 支持的编码代理参考,包括每个代理的准确说明文件路径和安装行为。

Convai Unity SDK 会为每个受支持的编码代理——Codex、Claude Code、Cursor、Gemini 和 VS Code Copilot——在项目文件中安装一个受管理的指令块。请使用此参考查找每个代理的确切文件路径和安装行为。

按代理划分的受管理指令文件

代理
受管理文件
位置

Codex

AGENTS.md

项目根目录

Claude Code

CLAUDE.md

项目根目录

Cursor

.cursor/rules/convai-unity-sdk.mdc

.cursor/rules/ 目录

Gemini

GEMINI.md

项目根目录

VS Code Copilot

.github/copilot-instructions.md

.github/ 目录

SDK 会相对于 Unity 项目根目录解析每个路径,而不是相对于包文件夹。

SDK 如何安装受管理块

这五个代理的安装逻辑完全相同。当你触发安装或更新时,SDK 会读取目标文件(如果存在),移除任何已由 <!-- BEGIN CONVAI UNITY SDK --><!-- END CONVAI UNITY SDK -->,并在文件末尾追加一个新的块。如果文件不存在,SDK 会创建它,包括任何缺失的父目录,例如 .cursor/rules/.github/。哨兵标记之外的内容会被保留,写入时会匹配文件现有的行尾(\r\n\n).

安装、更新或移除受管理块是手动操作——不会自动运行。请从 Convai Editor 的 AI 编码 部分,或从 Convai > AI 编码设置.

已安装的块会指示代理读取 Packages/com.convai.convai-sdk-for-unity/AIAssistantSkills/convai-unity-sdk/SKILL.md 及其链接的参考资料,以处理 Convai 特定工作流,并使用 Unity MCP 工具执行通用的场景、GameObject、资源、脚本、控制台和 Play Mode 操作,同时保留 Convai 自己的工具 用于 SDK 特定的配置和诊断。

各代理特定说明

代理
注意

Codex

首次安装时会在项目根目录创建。无需额外目录。

Claude Code

首次安装时会在项目根目录创建。无需额外目录。

Cursor

SDK 会创建 .cursor/rules/ 目录(如果不存在)。受管理块上方已存在的任何 Cursor 规则 frontmatter 都会被保留。

Gemini

首次安装时会在项目根目录创建。无需额外目录。

VS Code Copilot

SDK 会创建 .github/ 目录(如果不存在)。

后续步骤

AI 编码助手AI 编码助手快速开始MCP 工具参考AI 编码助手设置故障排除

最后更新于

这有帮助吗?