> 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/convai-unreal-engine-plugin/getting-started/install-the-convai-plugin.md).

# Install the Convai plugin

The Convai Unreal Engine plugin is available through two channels. Review the comparison below, choose the one that fits your workflow, then follow the corresponding steps.

{% embed url="<https://youtu.be/n-UG3nmMeZQ>" %}
Install the Convai plugin and add your first character
{% endembed %}

### Fab vs GitHub: which to choose

| Factor                   | Fab                     | GitHub Releases                                |
| ------------------------ | ----------------------- | ---------------------------------------------- |
| Update frequency         | Less frequent           | More frequent                                  |
| Stability                | Most stable builds      | Latest features; may include pre-release fixes |
| Install method           | Epic Games Launcher     | Manual: download, extract, copy to `Plugins/`  |
| Engine version selection | Handled by the launcher | Choose the zip matching your UE version        |

### Install the plugin

{% tabs %}
{% tab title="Fab (recommended)" %}
Fab provides stable, launcher-managed builds. Updates arrive less frequently than GitHub but require no manual file management.

{% stepper %}
{% step %}

#### Open the Fab listing

Open the Epic Games Launcher and navigate to the Fab store, or go directly to the plugin listing:

[Convai plugin on Fab](https://www.fab.com/listings/ba3145af-d2ef-434a-8bc3-f3fa1dfe7d5c)
{% endstep %}

{% step %}

#### Install to your engine or project

On the listing page, click **Install to Engine** to install the plugin for a specific engine version, or **Add to project** to add it directly to a project. Select the target engine or project and confirm.
{% endstep %}

{% step %}

#### Launch your project

Open your project in Unreal Engine. The plugin will be available for enabling in the next step.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="GitHub Releases" %}
GitHub Releases ships new features and fixes sooner than Fab. Use this method when you need the latest build or a specific plugin version.

{% stepper %}
{% step %}

#### Download the release zip

Go to [Convai Unreal Engine SDK releases on GitHub](https://github.com/Conv-AI/Convai-UnrealEngine-SDK-V4/releases) and find the release that matches the version you want. Download the zip file for your Unreal Engine version.
{% endstep %}

{% step %}

#### Extract the plugin

Extract the zip file. The extracted folder should be named `Convai` and contain `ConvAI.uplugin` at its root.
{% endstep %}

{% step %}

#### Create a Plugins folder in your project

In your project's root directory (the folder that contains your `.uproject` file), create a `Plugins/` folder if one does not already exist.
{% endstep %}

{% step %}

#### Move the plugin into your project

Copy or move the `Convai` folder into `Plugins/`. The final path should be:

```
YourProject/
  Plugins/
    Convai/
      ConvAI.uplugin
```

{% endstep %}

{% step %}

#### Open your project

Launch the Unreal Editor with your project. If prompted to rebuild modules, click **Yes**.
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}

### Enable the plugin

Both install methods require you to enable the plugin inside the editor:

{% stepper %}
{% step %}

#### Open the Plugins panel

In the Unreal Editor menu bar, select **Edit > Plugins**.
{% endstep %}

{% step %}

#### Find and enable Convai

In the search box, type `Convai`. Locate the **Convai** plugin in the results and check the **Enabled** checkbox.
{% endstep %}

{% step %}

#### Restart the editor

A restart prompt appears. Click **Restart Now**. After the editor reopens, the Convai editor window opens automatically and prompts you to sign in.
{% endstep %}
{% endstepper %}

{% hint style="success" %}
When the plugin loads correctly, the Convai toolbar icon appears in the Unreal Editor toolbar and the Convai editor window opens for sign-in.
{% endhint %}

### Next steps

{% content-ref url="/pages/yK6s42eZv16JXJzJnF9d" %}
[Configure your API key](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-your-api-key.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 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/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/install-the-convai-plugin.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.