# Installation

## 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.&#x20;

### 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](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/mac-microphone-permission-required-for-ue-5.0-and-5.3).

## Installing the plugin

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

1. [Directly from the Marketplace Link](https://www.unrealengine.com/marketplace/en-US/product/convai): 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**.&#x20;
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&#x26;token=cc9ae5c3-bf58-4b2b-ae10-224c2b10070e" alt=""><figcaption></figcaption></figure></div>
4. Restart Unreal Engine.&#x20;

## Set up the API key

1. [Find your API key.](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides-v2-under-development/getting-started/broken-reference)
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&#x26;token=9aef3a7c-e688-4cce-b761-d9dbce2a14d9" alt=""><figcaption></figcaption></figure></div>
4. Paste the API key into the **API Key** field.