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

导入并运行示例场景

导入捆绑的示例场景,并在构建自己的场景之前验证 SDK 是否已正确安装并连接。

适用于 Unity 的 Convai SDK 随附三个示例场景。在你构建自己的场景之前,运行其中一个是确认安装、API 密钥和音频设置是否正常工作的最快方式。

示例
说明

基础示例

使用 Convai_Char_Robot的核心设置和交互流程,

LipSync 示例

高质量角色 Sofia 支持实时口型同步,并提供一个调试中心,用于在播放模式下检查情绪、动态上下文和视觉状态

多角色示例

一个共享房间示例,演示多个 Convai 角色、交互目标、转录 UI,以及运行时名册变更

根据你安装 SDK 的方式,查找示例的步骤会有所不同。

1

打开包管理器

在 Unity 编辑器中,打开 窗口 > 包管理器。在左上角的下拉菜单中,选择 项目中的密钥,再选择 适用于 Unity 的 Convai SDK ,从列表中选择。

2

导入示例

在右侧的详细信息面板中,点击 Samples 选项卡。点击 导入 ,位于你要运行的示例旁边。

Unity 会将示例资源复制到 Assets/Samples/Convai SDK for Unity/<version>/。一个新文件夹会出现在 Assets/Samples/ 下方的项目窗口中。

3

打开场景

在项目窗口中,导航到已导入的示例文件夹并打开其中的 .unity 场景文件。

1

找到示例

通过资源商店安装时,所有示例场景都会自动导入到你的项目中。在项目窗口中,导航到:

Assets/Convai SDK For Unity/Samples/

其中有三个文件夹: BasicSample, LipSyncSample以及 MultiCharacterSample.

2

打开场景

打开 .unity 场景文件,位于你想运行的示例文件夹内。

场景打开后:

1

进入播放模式

按 播放。随着 SDK 初始化,Unity 控制台会记录以下几行:

  • [ConvaiRuntime] 启动成功 — SDK 已初始化所有内部服务

  • [RoomConnectionRuntimeAdapter] 房间连接成功(模式=create)。 — 已连接到 Convai 的房间

对着麦克风说话。角色会以语音和文本输出进行回应。

如果没有出现响应,且控制台显示警告,请查看 验证你的设置 以获取诊断检查清单。

在 LipSync 示例中, 示例调试中心 面板已经在场景中。点击游戏视图中的情绪、上下文或视觉按钮,可打开一个抽屉,在角色说话时显示实时状态。

示例渲染管线说明

示例场景是使用通用渲染管线(URP)构建的。如果你的项目使用的是其他渲染管线,导入后材质可能会显示为粉色。请使用 编辑 > 渲染 > 材质将材质转换为与你当前渲染管线相匹配的格式,然后选择适用于你管线的相应转换选项。

下一步

既然你已经确认 SDK 正常工作,请先了解每个场景组件的作用,再构建你自己的设置。

场景组件参考

最后更新于

这有帮助吗?