> 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).

# 快速上手

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

{% 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="/pages/a8bb2a08932b50633f711d4a8438fe78aaad0e53">/pages/a8bb2a08932b50633f711d4a8438fe78aaad0e53</a></td></tr><tr><td><strong>安装 Convai 插件</strong><br>从 Fab 或 GitHub Releases 安装，并在您的项目中启用该插件。</td><td><a href="/pages/1e7f8ff5f6dd180c804dba754f19c21a745be07f">/pages/1e7f8ff5f6dd180c804dba754f19c21a745be07f</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="/pages/d6af0b14fc209017d2d18543ad38076bb0efe8f6">/pages/d6af0b14fc209017d2d18543ad38076bb0efe8f6</a></td></tr><tr><td><strong>场景组件参考</strong><br>Convai Chatbot、Player、Object 和 Face Sync 组件及其字段的参考。</td><td><a href="/pages/98b41781157f6eec98a195dad1b57f66765cf380">/pages/98b41781157f6eec98a195dad1b57f66765cf380</a></td></tr><tr><td><strong>添加您的第一个 Convai 角色</strong><br>将一个 Convai 角色放置到关卡中，并与其进行实时语音对话。</td><td><a href="/pages/47cd8b5064f2e1f1738f08d50b1097ad47ed212c">/pages/47cd8b5064f2e1f1738f08d50b1097ad47ed212c</a></td></tr></tbody></table>

### 角色骨骼

将 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="/pages/f0a9565e073a000fe0ed7df2961660e00793150b">/pages/f0a9565e073a000fe0ed7df2961660e00793150b</a></td></tr><tr><td><strong>设置 Reallusion（CC）角色</strong><br>导出 Reallusion CC4 或 CC5 头像，将其导入 Unreal，并连接 Convai。</td><td><a href="/pages/d29e5c59616e0066f5596223946116f5c08bc90d">/pages/d29e5c59616e0066f5596223946116f5c08bc90d</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="/pages/ddab80eff30a95a57bb3cec04bc4566233e30263">/pages/ddab80eff30a95a57bb3cec04bc4566233e30263</a></td></tr><tr><td><strong>配置角色音频</strong><br>调整语音播放音量，启用空间音频衰减，并设置中断淡出时长。</td><td><a href="/pages/2f681ae01ba11fe882d6b331cca0444e0a06402d">/pages/2f681ae01ba11fe882d6b331cca0444e0a06402d</a></td></tr><tr><td><strong>配置对话输入</strong><br>在按键说话和免提模式之间切换，调整 VAD 设置，并发送文本消息。</td><td><a href="/pages/9b983ed32e78e3fecceef1f1ca84663abe05edca">/pages/9b983ed32e78e3fecceef1f1ca84663abe05edca</a></td></tr><tr><td><strong>添加聊天 UI</strong><br>添加内置覆盖层或 3D 世界内小组件，或者将自定义小组件连接到转录委托。</td><td><a href="/pages/16dba40249f8c38f0e33f50c10a68569851148b6">/pages/16dba40249f8c38f0e33f50c10a68569851148b6</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="/pages/1f909841a8dc37e6adc6461224d8b1968155a87c">/pages/1f909841a8dc37e6adc6461224d8b1968155a87c</a></td></tr></tbody></table>

### 下一步

在验证设置之后，浏览“功能”部分，为您的角色添加 Actions、Emotion、Long-Term Memory 或 Vision。

{% 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.