> 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 引入培训模拟、交互式体验和游戏中。场景中的 Actor 可以进行实时语音和文本对话、表达情绪、让面部动画与语音同步，并响应玩家动作——所有这些都可按项目进行配置。核心运行时工作流程以 Blueprint 为先：配置角色、驱动对话，并通过 Blueprint 图表配置大多数功能行为，而无需编写 C++。每项功能都为可选，并建立在核心组件之上；只添加项目所需的部分。

{% hint style="info" %}
**刚接触这个插件？** 跟随 [入门](/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="/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="/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="/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="/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="/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="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context.md">动态上下文</a></td></tr><tr><td><strong>Emotion</strong><br>Convai 会从对话中推断情绪，并驱动 blendshape 表情。</td><td><a href="/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="/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="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design.md">叙事设计</a></td></tr><tr><td><strong>场景元数据</strong><br>为关卡中的 Actor 添加标签，使角色能够感知并对其采取行动。</td><td><a href="/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="/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="/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/gaze-attention.md">注视注意力</a></td></tr><tr><td><strong>口型同步</strong><br>根据响应音频实时驱动嘴部和面部的 blendshape。</td><td><a href="/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="/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="/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="/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="/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` 用于为关卡中的 Actor 标记实时场景属性，基于视线驱动的注意力（带轮廓高亮和屏幕光标），以及模糊枚举匹配，使 AI 的轻微拼写变化不再丢弃动作参数。参见 [发行说明](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/overview/release-notes.md) 以查看完整更新日志。

### 下一步

{% content-ref url="/pages/fb3a2bacc1ba8d2d274717ebd7a3ac02e56aabb8" %}
[快速开始](/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.
