Installation

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.

• Ensure having the required C++ toolchains mentioned here. 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

• For UE 5.3 and UE 5.0, follow this guide to enable microphone permissions.

Installing the plugin

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

1. Directly from the Marketplace Link: Recommended for easy installation and tracking updates to the plugin. (UE 5.1 - 5.3)

2. Building from Github Source: 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.

   
4. Restart Unreal Engine.

Set up the API key

1. Find your API key.

2. Go to Edit > Project Settings.

3. Choose Convai under the Plugins section on the left bar.

   
4. Paste the API key into the API Key field.