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

AI 编码助手快速开始

打开 AI Coding Setup,接受 Unity MCP 条款,安装编码代理的说明,并验证 Convai 的 MCP 工具已准备就绪。

Convai 通过支持 SDK 的工具扩展了 Unity 的 MCP 服务器,使诸如 Codex、Claude Code 或 Cursor 之类的编码代理能够直接在你的项目中配置 Convai 组件。首次将代理连接到已安装 Convai Unity SDK 的项目时,请使用此快速入门。完成后,你的代理将已安装托管说明,并且 AI 编程部分会显示每个 Convai 工具都已注册。

前提条件

  • Unity 6 (6000.x) 或更高版本——Convai 的 AI 编程工具需要 Unity 6000 或更新版本。

  • 项目中安装了 Convai Unity SDK。请参见 安装 Convai Unity SDK.

  • 兼容的 Unity AI Assistant 包(com.unity.ai.assistant,版本 2.13.0 或更高且低于 3.0.0 ——一个 2.13.0 构建必须带有预发布标签 pre.2 或更高版本,并且 3.0.0 构建仅作为预发布版本被接受,绝不会是最终正式版)。请手动安装,或在本教程中直接安装。

  • 已在你的机器上安装受支持的编码代理,例如 Codex CLI、Claude Code 或 Cursor。请参见 受支持的编码代理 获取完整列表。

打开 AI 编程设置

1

打开 AI 编程部分

在 Unity 编辑器菜单栏中,选择 Convai > AI 编码设置。这会打开 AI 编码 Convai 编辑器窗口中的

该部分的 设置健康状态 卡片显示四行就绪状态: Unity 6000+, Unity AI Assistant, 已打包的 Convai 技能,以及 Convai MCP 工具。每一行显示 就绪需要注意.

2

接受 Unity MCP 条款

Unity 可能会在该项目中此功能首次激活时,提示你接受 Unity AI Assistant 和 MCP 服务器的服务条款。接受提示,以便 Unity 的 MCP 服务器和 Convai 的工具能够注册。如果没有出现提示,请打开 项目设置 > AI > Unity MCP Server 直接接受条款,并确认哪些 MCP 客户端已连接到你的项目。

3

解决任何显示警告的行

每一条未就绪的行都会显示一个 修复 按钮。点击 修复 旁边的 Unity AI Assistant 以安装 com.unity.ai.assistant@2.14.0-pre.1 通过 Package Manager——Unity 会重新编译并自动更新该行。点击 修复 旁边的 已打包的 Convai 技能Convai MCP 工具 以刷新包资源并重新注册 Convai 的工具,而无需重新安装 Assistant 包。

安装你的编码代理的托管说明

1

选择你的编码代理

滚动到 已管理的项目指令 卡片。Convai 会列出每个受支持的代理及其管理的文件——例如 AGENTS.md 适用于 Codex, CLAUDE.md 用于 Claude Code,以及 .cursor/rules/convai-unity-sdk.mdc 用于 Cursor。参见 受支持的编码代理 以获取完整列表和各代理说明。

2

安装托管说明

点击 安装 在你的代理旁边。Convai 会写入一个由哨兵分隔的块,由 <!-- BEGIN CONVAI UNITY SDK --><!-- END CONVAI UNITY SDK -->标记,而不会干扰任何现有内容。该按钮在该块存在后会变为 Update ,并且 移除 随后可用以将其删除。

托管说明会指引你的代理读取 Packages/com.convai.convai-sdk-for-unity/AIAssistantSkills/convai-unity-sdk/SKILL.md 及其链接引用,使用 Unity 的通用 MCP 工具处理 GameObject、脚本和场景,并使用 Convai 的工具进行 SDK 配置和诊断。

验证工具数量

Convai MCP 工具 行显示 20/20 已注册 ,一旦 Unity 的 MCP 注册表在工具合同版本 4 下注册了全部二十个 Convai 工具。如果数量更少,或该行列出了缺失或意外的工具名称,请点击 修复 旁边的 Convai MCP 工具 以刷新注册表并重新编译。

提示代理构建你的场景

在已安装托管说明并验证工具数量后,用自然语言提示你的代理。Convai 的工具处理特定于 SDK 的配置;你的代理的 Unity MCP 工具处理通用的 GameObject、脚本和场景操作。

任务
示例提示

构建一个场景

"设置一个训练模拟房间,里面有一个 Convai Player 和一个名为 Instructor 的 Convai Character。"

添加聊天 UI

"将随附的聊天 UI 添加到场景中,以便在对话过程中可见转录内容。"

切换按住说话或免提

"将房间切换为按住说话输入模式。"

添加对象

"在工作台旁边添加一个红色灭火器 GameObject。"

启用视觉

"为 Instructor 角色开启视觉,以便它能看到工作台。"

视觉设置不是 Convai 的二十个基础工具之一,因此你的代理通过编辑 ConvaiRoomManager 并添加 ConvaiVisionPublisher 直接处理。请参阅 Vision 快速入门 来配置它所设置的确切字段。

接下来可尝试的内容

在你自己的项目中,给你的代理提示上面两到三个任务,并在进入 Play Mode 之前在 Hierarchy 中检查生成的场景。

AI 编码助手受支持的编码代理MCP 工具参考AI 编码助手设置故障排除

最后更新于

这有帮助吗?