> 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/unreal-engine/guides-v2-under-development/getting-started/download-and-setup.md).

# 安装

## 先决条件

### 为 Windows 安装 Visual Studio

* 下载 [从此处获取 Visual Studio](https://visualstudio.microsoft.com/downloads/).
* 确保拥有所提到的必需 C++ 工具链 [<mark style="color:绿色;">**这里**</mark>](https://docs.unrealengine.com/5.1/en-US/setting-up-visual-studio-development-environment-for-cplusplus-projects-in-unreal-engine/). 如果你已经安装了 Visual Studio，可以打开安装程序并选择 **“修改”** 以添加上述工具链。

### 为 Mac 安装 XCode

* 下载 [从应用商店获取 XCode](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
* 对于 UE 5.3 和 UE 5.0，请按照此 [指南启用麦克风权限](/api-docs/zh/cha-jian-yu-ji-cheng/unreal-engine/mac-microphone-permission-required-for-ue-5.0-and-5.3.md).

## 安装插件

根据你的需求，有两种安装插件的方法

1. [直接通过 Marketplace 链接](https://www.unrealengine.com/marketplace/en-US/product/convai)：建议用于便于安装以及跟踪插件更新。（UE 5.1 - 5.3）
2. [从 GitHub 源码构建](https://github.com/Conv-AI/Convai-UnrealEngine-SDK?tab=readme-ov-file#installation)：适用于 UE 源码构建，以及 Marketplace 上不受支持的 UE 版本，但不保证与 Marketplace 方式相同。（UE 4.26 - 5.0）

## 设置你的项目

1. 从顶部工具栏，前往 **Edit > Plugins**.
2. 找到 **Convai** 插件。
3. 勾选复选框以启用插件。<br>

   <div align="left"><figure><img src="/files/370cdd6866aa78705ad5aec0e229ca68896b2cdc" alt=""><figcaption></figcaption></figure></div>
4. 重启 Unreal Engine。

## 设置 API 密钥

1. [找到你的 API 密钥。](broken://pages/444c9c4561cc9b677405ad89de394949078bf12d#get-your-unique-api-key)
2. 前往 **编辑 > 项目设置**.
3. 选择 **Convai** 在 **Plugins** 左侧栏中的部分。<br>

   <div align="left"><figure><img src="/files/381b3f3bb3b90c70df7cde283112d26da475ba58" alt=""><figcaption></figcaption></figure></div>
4. 将 API 密钥粘贴到 **API 密钥** 字段中。


---

# 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/unreal-engine/guides-v2-under-development/getting-started/download-and-setup.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.