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

# Convai Unreal Engine 插件

查找 Convai Unreal Engine 插件的安装指南、功能文档、Blueprint 参考和故障排查页面。

Convai Unreal Engine 插件可将 Unreal Engine 5 项目连接到 Convai，为训练模拟、交互体验和游戏带来对话式 AI。场景中的角色可以实时进行语音和文本对话、表达情绪、让面部动画与语音同步，并响应玩家操作，而且所有功能都可按项目配置。核心运行时工作流以 Blueprint 为主：配置角色、驱动对话，并通过 Blueprint 图表连接大多数功能行为，无需编写 C++。每项功能都可选择启用，并基于核心组件构建；只添加项目所需的功能。

{% hint style="info" %}
**刚开始使用此插件？** 请参阅 [入门指南](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started.md) ，了解如何安装、配置 API 密钥并运行首个 AI 角色。
{% 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/overview.md">Convai Unreal Engine 插件概览</a></td></tr><tr><td><strong>兼容性与要求</strong><br>UE 5.x 版本支持、目标平台和角色骨架兼容性。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/compatibility-and-requirements.md">兼容性与要求</a></td></tr><tr><td><strong>入门指南</strong><br>安装插件、配置 API 密钥并添加首个 AI 角色。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started.md">快速开始</a></td></tr><tr><td><strong>核心概念</strong><br>运行时架构、会话生命周期、对话流程和 Blueprint 事件。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/core-concepts.md">核心概念</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/features/character-actions.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/features/dynamic-context.md">动态上下文</a></td></tr><tr><td><strong>情绪</strong><br>Convai 根据对话推断情绪，并驱动混合变形表情。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/emotion.md">情绪</a></td></tr><tr><td><strong>长期记忆</strong><br>角色使用最终用户 ID，跨会话记住每位玩家。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory.md">长期记忆</a></td></tr><tr><td><strong>叙事设计</strong><br>通过 Blueprint 按名称触发脚本化的对话分支和章节。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design.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/features/scene-metadata.md">场景元数据</a></td></tr><tr><td><strong>视觉</strong><br>将摄像头画面流式传输到 Convai，让角色描述所见内容。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision.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/features/gaze-attention.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/features/lip-sync.md">口型同步</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/advanced-topics.md">高级主题</a></td></tr><tr><td><strong>Blueprint 参考</strong><br>所有组件的完整属性、函数和事件列表。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/blueprint-reference.md">Blueprint 参考</a></td></tr><tr><td><strong>Convai 编辑器窗口</strong><br>在编辑器中登录、浏览示例并导出诊断日志。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/editor-window.md">Convai 编辑器窗口</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/troubleshooting.md">故障排查</a></td></tr></tbody></table>

### 最新版本

<code class="expression">space.vars.unreal\_plugin\_version</code> 包含由 LLM 发出的角色动作自动触发的手势和指向动画， `UConvaiObjectComponent` 可为关卡演员添加标签并设置实时场景属性；支持注视驱动的注意力功能，包括轮廓高亮和屏幕光标；还支持模糊枚举匹配，因此 AI 轻微的拼写变化不再导致动作参数丢失。完整变更记录请参阅 [发行说明](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/overview/release-notes.md) 。

### 后续步骤

{% content-ref url="/pages/fb3a2bacc1ba8d2d274717ebd7a3ac02e56aabb8" %}
[快速开始](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started.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.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.
