> 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.md).

# Getting started

By the end of this section, your project contains a working Convai character in Unreal Engine. Follow the core path pages in order — each step builds directly on the previous one. Character rig and configuration pages are optional branches you can complete in any order after the first conversation is working.

{% hint style="info" %}
**Before you begin:** Confirm your environment meets the requirements on the [Prerequisites](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/prerequisites.md) page — engine version, account, platform, and network access.
{% endhint %}

### Preparation

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Prerequisites</strong><br>Verify engine version, account, platform, and network requirements before installing.</td><td><a href="/pages/rEn97nz5rOXoeSAteVQt">/pages/rEn97nz5rOXoeSAteVQt</a></td></tr><tr><td><strong>Install the Convai plugin</strong><br>Install from Fab or GitHub Releases and enable the plugin in your project.</td><td><a href="/pages/zf9D2ktrnLMIujjWxizK">/pages/zf9D2ktrnLMIujjWxizK</a></td></tr></tbody></table>

### Core path

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Configure your API key</strong><br>Sign in through the Convai editor window and store your API key.</td><td><a href="/pages/yK6s42eZv16JXJzJnF9d">/pages/yK6s42eZv16JXJzJnF9d</a></td></tr><tr><td><strong>Scene components reference</strong><br>Reference for the Convai Chatbot, Player, Object, and Face Sync components and their fields.</td><td><a href="/pages/TAMFvBX6DiCF3cUBeYtP">/pages/TAMFvBX6DiCF3cUBeYtP</a></td></tr><tr><td><strong>Add your first Convai character</strong><br>Place a Convai character in a level and have a live voice conversation with it.</td><td><a href="/pages/62jSGyEcDL1LUmbU2yXD">/pages/62jSGyEcDL1LUmbU2yXD</a></td></tr></tbody></table>

### Character rigs

Add Convai to a specific character type. Complete this after the first conversation is working.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Set up a MetaHuman character</strong><br>Wire Convai lip sync and animation to a MetaHuman character in your project.</td><td><a href="/pages/XbtaAPxghTKgeXTDOIn3">/pages/XbtaAPxghTKgeXTDOIn3</a></td></tr><tr><td><strong>Set up a Reallusion (CC) character</strong><br>Export a Reallusion CC4 or CC5 avatar, import it into Unreal, and connect Convai.</td><td><a href="/pages/GjMgGIpOc6IFNfXiyJTr">/pages/GjMgGIpOc6IFNfXiyJTr</a></td></tr></tbody></table>

### Configuration

Tune audio, input, and UI after the first conversation is working. Each page is independent.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Configure the microphone</strong><br>Select a capture device and adjust volume so the player's voice reaches the character.</td><td><a href="/pages/9KUQ9XKjAMU6OaZfGxfJ">/pages/9KUQ9XKjAMU6OaZfGxfJ</a></td></tr><tr><td><strong>Configure character audio</strong><br>Adjust speech playback volume, enable spatial audio attenuation, and set the interrupt fade duration.</td><td><a href="/pages/hFMUaDotYrGAMPyQ8J6G">/pages/hFMUaDotYrGAMPyQ8J6G</a></td></tr><tr><td><strong>Configure conversation input</strong><br>Switch between push-to-talk and hands-free mode, tune VAD settings, and send text messages.</td><td><a href="/pages/wO1MGAXD0InYM2apk7cV">/pages/wO1MGAXD0InYM2apk7cV</a></td></tr><tr><td><strong>Add the chat UI</strong><br>Add the built-in overlay or 3D in-world widget, or wire a custom widget to the transcript delegate.</td><td><a href="/pages/HucPjSqJx8pLUO4dNPgQ">/pages/HucPjSqJx8pLUO4dNPgQ</a></td></tr></tbody></table>

### Validate your setup

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Validate your setup</strong><br>Run through a checklist to confirm that every part of your setup is working before adding features.</td><td><a href="/pages/g8UGNK2Dicyeh9I9zZ6x">/pages/g8UGNK2Dicyeh9I9zZ6x</a></td></tr></tbody></table>

### Next steps

Once you have validated your setup, explore the Features section to add Actions, Emotion, Long-Term Memory, or Vision to your characters.

{% content-ref url="/pages/AGnvNMLpxOxMFMMgKjWH" %}
[Features](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features.md)
{% endcontent-ref %}

Review Core Concepts for a deeper understanding of the conversation pipeline and component architecture before building further.

{% content-ref url="/pages/uL5SILtUmeFvx3EidUSt" %}
[Core concepts](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts.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, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.