> 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 角色。请按顺序浏览核心路径页面——每一步都直接建立在上一步的基础上。角色绑定和配置页面是可选分支，可在首次对话正常运行后按任意顺序完成。

{% hint style="info" %}
**开始之前：** 请确认你的环境符合 [先决条件](https://docs.convai.com/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="https://docs.convai.com/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="https://docs.convai.com/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="https://docs.convai.com/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="https://docs.convai.com/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="https://docs.convai.com/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>

### 角色绑定

将 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="https://docs.convai.com/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="https://docs.convai.com/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="https://docs.convai.com/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="https://docs.convai.com/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="https://docs.convai.com/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 场景内小组件，或者将自定义小组件连接到 transcript 委托。</td><td><a href="https://docs.convai.com/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="https://docs.convai.com/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="https://docs.convai.com/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" %}
[功能](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features.md)
{% endcontent-ref %}

继续构建之前，请阅读核心概念，深入了解对话流程和组件架构。

{% content-ref url="/pages/d4d67f0a1b2a7584ab386f8d7585472886dfd1d6" %}
[核心概念](https://docs.convai.com/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.
