> 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 密钥](/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 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.