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

# 前提条件

在将 Convai Unreal Engine 插件安装到项目之前，先验证引擎版本、账户、平台和网络要求。

安装 Convai Unreal Engine 插件前，请逐项确认所有要求。缺少任何一项都将导致插件无法加载或正常运行。

### Unreal Engine 版本

该插件支持 Unreal Engine 5.0 及更高版本——包括所有 UE 5.x 版本。最低支持版本为 <code class="expression">space.vars.unreal\_min\_version</code>.

该 **Convai 编辑器窗口** ——用于通过 API 密钥登录的编辑器内面板——要求使用 **UE 5.2 或更高版本**。在 UE 5.0 和 5.1 中，所有运行时游戏功能均可使用，但不提供编辑器登录面板。请将 API 密钥添加到 `Config/DefaultEngine.ini` 而不是通过面板添加——请参阅 [配置 API 密钥](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-your-api-key.md).

| UE 版本范围   | 插件支持 | API 密钥设置                                         |
| --------- | ---- | ------------------------------------------------ |
| 5.0–5.1   | 支持   | 将密钥添加到 `Config/DefaultEngine.ini` （项目设置中显示的值为只读） |
| 5.2 及更高版本 | 支持   | 通过 Convai 编辑器窗口登录（启用插件后会自动打开）                    |

{% hint style="warning" %}
在 Unreal Engine 5.0 和 5.1 中，Convai 编辑器窗口不会加载。请将 API 密钥添加到 `Config/DefaultEngine.ini` — **API 密钥** 字段在这些引擎版本的“项目设置”中为只读。
{% endhint %}

### Convai 账户和 API 密钥

你需要一个 Convai 账户来验证插件身份，以及创建或管理角色。

{% stepper %}
{% step %}

#### 创建 Convai 账户

前往 [convai.com](https://convai.com) 如果您还没有账号，请注册一个免费账号。
{% endstep %}

{% step %}

#### 登录控制面板

登录并打开您的账号控制面板。您可以在账号设置中找到 API 密钥。
{% endstep %}

{% step %}

#### 复制 API 密钥

复制 API 密钥字符串。安装后，您需要输入该密钥：在 UE 5.2 及更高版本中，通过 Convai 编辑器窗口输入；在 UE 5.0 和 5.1 中，则在 `Config/DefaultEngine.ini` 中输入。请参阅 [配置 API 密钥](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-your-api-key.md).
{% endstep %}
{% endstepper %}

### 引擎插件（捆绑依赖项）

Convai Unreal Engine 插件依赖于两个随 Unreal Engine 一同提供的引擎插件。启用 Convai 插件时，这两个插件也会自动启用：

| 依赖项                 | 用途                          |
| ------------------- | --------------------------- |
| `AudioCapture`      | 在 Win64 和 Android 上提供麦克风输入。 |
| `AndroidPermission` | 在 Android 上处理运行时麦克风权限请求。    |

无需手动启用这些插件。如果你的项目之前曾禁用其中任意一个，请在以下菜单中重新启用： **编辑 > 插件** 然后再启用 Convai 插件。

### 支持的平台

| 平台      | 支持 |
| ------- | -- |
| Win64   | 是  |
| Android | 是  |
| 其他      | 否  |

此版本不支持 Mac、iOS、Linux 和游戏主机平台。

### 网络访问

该插件在运行时通过 WebRTC 连接到 Convai。请确保运行项目的设备能够通过 HTTPS 和 WebRTC 端口访问 Convai 的端点。阻止 WebRTC 的防火墙或代理会导致对话无法启动。

{% hint style="success" %}
满足所有要求后，即可安装该插件。
{% endhint %}

### 后续步骤

{% content-ref url="/pages/1e7f8ff5f6dd180c804dba754f19c21a745be07f" %}
[安装 Convai 插件](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/install-the-convai-plugin.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/prerequisites.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.
