> 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 插件之前，请先验证每一项要求。缺少其中任何一项都将导致插件无法正确加载或运行。

### 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 密钥](/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 编辑器窗口，或在 `Config/DefaultEngine.ini` 在 UE 5.0 和 5.1 上通过 [配置你的 API 密钥](/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 插件](/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 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/prerequisites.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.