> 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/plugins-and-integrations/unreal-engine/installation.md).

# Installation | Unreal Engine

Install Convai plugin for Unreal Engine. Follow step-by-step instructions for Visual Studio and XCode setup.

## Prerequisites

### Installing Visual Studio for Windows

* Download [Visual Studio from here](https://visualstudio.microsoft.com/downloads/).
* Ensure having the required C++ toolchains mentioned [<mark style="color:green;">**here**</mark>](https://docs.unrealengine.com/5.1/en-US/setting-up-visual-studio-development-environment-for-cplusplus-projects-in-unreal-engine/). If you already have Visual Studio installed, you may open the installer and select **'Modify'** to add the above mentioned toolchains.

### Installing XCode for Mac

* Download [XCode from the app store](https://apps.apple.com/us/app/xcode/id497799835?mt=12)
* For UE 5.3 and UE 5.0, follow this [guide to enable microphone permissions](/api-docs/plugins-and-integrations/unreal-engine/mac-microphone-permission-required-for-ue-5.0-and-5.3.md).

## Installing the plugin

There are two methods to install the plugin depending on your requirements

1. [Directly from the Marketplace Link](https://www.fab.com/listings/ba3145af-d2ef-434a-8bc3-f3fa1dfe7d5c): Recommended for easy installation and tracking updates to the plugin. (UE 5.1 - 5.3)
2. [Building from Github Source](https://github.com/Conv-AI/Convai-UnrealEngine-SDK?tab=readme-ov-file#installation): For source UE builds and for unsupported UE versions on the marketplace, but not guranteed as the marketplace approach. (UE 4.26 - 5.0)

## Set up your project

1. From the top toolbar, go to **Edit > Plugins**.
2. Find the **Convai** plugin.
3. Click the checkbox to enable the plugin.<br>

   <div align="left"><figure><img src="https://413558230-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEtUJA212Zc1S9ACc8T4l%2Fuploads%2FQzX7J6PciJTigyHzChFB%2Fimage.png?alt=media&amp;token=cc9ae5c3-bf58-4b2b-ae10-224c2b10070e" alt=""><figcaption></figcaption></figure></div>
4. Restart Unreal Engine.

## Set up the API key

1. [Find your API key.](broken://pages/CJVBwanK70esQhUqiKHl#get-your-unique-api-key)
2. Go to **Edit > Project Settings**.
3. Choose **Convai** under the **Plugins** section on the left bar.<br>

   <div align="left"><figure><img src="https://413558230-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEtUJA212Zc1S9ACc8T4l%2Fuploads%2FivwTDf1N1Oy86IBD167n%2Fimage.png?alt=media&amp;token=9aef3a7c-e688-4cce-b761-d9dbce2a14d9" alt=""><figcaption></figcaption></figure></div>
4. Paste the API key into the **API Key** field.


---

# 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/plugins-and-integrations/unreal-engine/installation.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.