> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started.md).

# 快速开始

安装 Convai Unreal Engine 插件，配置你的 API 密钥，并放置你的第一个会说话的角色——按顺序完成核心路径以获得最快结果。

在本节结束时，你的项目中将包含一个可正常工作的 Unreal Engine Convai 角色。请按顺序完成核心路径页面——每一步都直接建立在前一步之上。角色 Rig 和配置页面是可选分支，你可以在第一个对话正常工作后按任意顺序完成。

{% hint style="info" %}
**在开始之前：** 请确认你的环境满足以下页面中的要求： [前置条件](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/prerequisites.md) 页面——引擎版本、账号、平台和网络访问。
{% endhint %}

### 准备工作

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>前置条件</strong><br>在安装之前，请先验证引擎版本、账号、平台和网络要求。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/prerequisites.md">前提条件</a></td></tr><tr><td><strong>安装 Convai 插件</strong><br>从 Fab 或 GitHub Releases 安装，并在项目中启用该插件。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/install-the-convai-plugin.md">安装 Convai 插件</a></td></tr></tbody></table>

### 核心路径

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>配置你的 API 密钥</strong><br>通过 Convai 编辑器窗口登录并保存你的 API 密钥。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-your-api-key.md">配置你的 API 密钥</a></td></tr><tr><td><strong>场景组件参考</strong><br>Convai Chatbot、Player、Object 和 Face Sync 组件及其字段的参考。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/scene-components-reference.md">场景组件参考</a></td></tr><tr><td><strong>添加你的第一个 Convai 角色</strong><br>将一个 Convai 角色放置到关卡中，并与其进行实时语音对话。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/add-your-first-convai-character.md">添加你的第一个 Convai 角色</a></td></tr></tbody></table>

### 角色 Rig

将 Convai 添加到特定角色类型。请在第一个对话正常工作后再完成此步骤。

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>配置 MetaHuman 角色</strong><br>在你的项目中将 Convai 口型同步和动画连接到 MetaHuman 角色。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/set-up-a-metahuman-character.md">设置 MetaHuman 角色</a></td></tr><tr><td><strong>配置 Reallusion（CC）角色</strong><br>导出 Reallusion CC4 或 CC5 头像，将其导入 Unreal，然后连接 Convai。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/set-up-a-reallusion-cc-character.md">设置 Reallusion（CC）角色</a></td></tr></tbody></table>

### 配置

在第一个对话正常工作后，调整音频、输入和 UI。每个页面都是独立的。

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>配置麦克风</strong><br>选择采集设备并调整音量，以便玩家的声音能够被角色听到。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-the-microphone.md">配置麦克风</a></td></tr><tr><td><strong>配置角色音频</strong><br>调整语音播放音量，启用空间音频衰减，并设置中断淡出时长。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-character-audio.md">配置角色音频</a></td></tr><tr><td><strong>配置对话输入</strong><br>在按键通话和免提模式之间切换，调整 VAD 设置，并发送文本消息。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-conversation-input.md">配置对话输入</a></td></tr><tr><td><strong>添加聊天 UI</strong><br>添加内置覆盖层或 3D 世界小部件，或者将自定义小部件连接到转录委托。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/add-the-chat-ui.md">添加聊天 UI</a></td></tr></tbody></table>

### 验证你的设置

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>验证你的设置</strong><br>在添加功能之前，按清单检查以确认你的设置各部分都能正常工作。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/validate-your-setup.md">验证你的设置</a></td></tr><tr><td><strong>Stack O Bot 教程设置</strong><br>使用 Epic 免费提供的 Stack O Bot 和 Convai 教程文件，构建角色动作教程所录制的示例项目。</td><td><a href="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/stack-o-bot-tutorial-setup.md">Stack O Bot 教程设置</a></td></tr></tbody></table>

### 下一步

在验证完设置后，浏览“功能”部分，为你的角色添加动作、情绪、长期记忆或视觉能力。

{% content-ref url="/pages/73868092346b12dc2f5857d5bfc4ca5240a4410e" %}
[功能](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features.md)
{% endcontent-ref %}

在进一步构建之前，请查看核心概念，以更深入地理解对话流程和组件架构。

{% content-ref url="/pages/d4d67f0a1b2a7584ab386f8d7585472886dfd1d6" %}
[核心概念](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/core-concepts.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.