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

# Convai Unreal Engine plugin

The Convai Unreal Engine plugin connects Unreal Engine 5 projects to Convai, bringing conversational AI into training simulations, interactive experiences, and games. Actors in a scene hold real-time voice and text conversations, express emotions, animate faces in sync with speech, and respond to player actions — all configurable per project. Core runtime workflows are Blueprint-first: configure characters, drive conversations, and wire most feature behavior from Blueprint graphs without writing C++. Each feature is opt-in and builds on the core components; add only what your project needs.

{% hint style="info" %}
**New to the plugin?** Follow [Getting started](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started.md) to install, configure your API key, and run your first AI character.
{% endhint %}

### Learn the plugin

<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>Overview</strong><br>What the plugin is, how its modules are structured, and a map of every feature.</td><td><a href="/pages/YZJCXRAzNrUUtxgSDzG8">/pages/YZJCXRAzNrUUtxgSDzG8</a></td></tr><tr><td><strong>Compatibility and requirements</strong><br>UE 5.x version support, platform targets, and character rig compatibility.</td><td><a href="/pages/3oblPsurIGf7eseuvZPm">/pages/3oblPsurIGf7eseuvZPm</a></td></tr><tr><td><strong>Getting started</strong><br>Install the plugin, configure your API key, and add your first AI character.</td><td><a href="/pages/5oPvRJZZEVuIVMYZLYh8">/pages/5oPvRJZZEVuIVMYZLYh8</a></td></tr><tr><td><strong>Core concepts</strong><br>Runtime architecture, session lifecycle, conversation flow, and Blueprint events.</td><td><a href="/pages/uL5SILtUmeFvx3EidUSt">/pages/uL5SILtUmeFvx3EidUSt</a></td></tr></tbody></table>

### Features

Each feature is opt-in and builds on the core components.

<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>Character actions</strong><br>Characters execute typed in-scene commands (Move To, Follow, custom).</td><td><a href="/pages/NjVHOB3MELicvSSurEPd">/pages/NjVHOB3MELicvSSurEPd</a></td></tr><tr><td><strong>Dynamic context</strong><br>Push live world state and events into character knowledge at runtime.</td><td><a href="/pages/VtreGBSkV3v9EqIKSNQH">/pages/VtreGBSkV3v9EqIKSNQH</a></td></tr><tr><td><strong>Emotion</strong><br>Convai infers emotion from conversation and drives blendshape expressions.</td><td><a href="/pages/dXQYIyvmX3Z6hN65zfqt">/pages/dXQYIyvmX3Z6hN65zfqt</a></td></tr><tr><td><strong>Long-term memory</strong><br>Characters remember each player across sessions using an end-user ID.</td><td><a href="/pages/DMTej4CYSOHRGmpxRVHi">/pages/DMTej4CYSOHRGmpxRVHi</a></td></tr><tr><td><strong>Narrative design</strong><br>Trigger scripted conversation branches and sections by name from Blueprint.</td><td><a href="/pages/adQWw1CiOcNdZRsmpBeB">/pages/adQWw1CiOcNdZRsmpBeB</a></td></tr><tr><td><strong>Scene metadata</strong><br>Tag level actors so characters are aware of and can act on them.</td><td><a href="/pages/vbGxc89Y9wflNJFl3EW4">/pages/vbGxc89Y9wflNJFl3EW4</a></td></tr><tr><td><strong>Vision</strong><br>Stream camera frames to Convai so characters can describe what they see.</td><td><a href="/pages/5TGq7ASz4xWw1Dhn8qy3">/pages/5TGq7ASz4xWw1Dhn8qy3</a></td></tr><tr><td><strong>Gaze attention</strong><br>Route the object under the player's crosshair as context to the active character.</td><td><a href="/pages/LWOprxC8MMYzTxzOV4pu">/pages/LWOprxC8MMYzTxzOV4pu</a></td></tr><tr><td><strong>Lip sync</strong><br>Drives mouth and facial blendshapes from response audio in real time.</td><td><a href="/pages/MUqoUJUdEwZL84AyCxoU">/pages/MUqoUJUdEwZL84AyCxoU</a></td></tr></tbody></table>

### Reference

<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>Advanced topics</strong><br>Production authentication and integration guides beyond the core setup path.</td><td><a href="/pages/2OW0dOqVCY8obz8ud9x2">/pages/2OW0dOqVCY8obz8ud9x2</a></td></tr><tr><td><strong>Blueprint reference</strong><br>Full property, function, and event surface for all components.</td><td><a href="/pages/YJZ9npCu6kBrPvgWNPcz">/pages/YJZ9npCu6kBrPvgWNPcz</a></td></tr><tr><td><strong>The Convai editor window</strong><br>Sign in, browse samples, and export diagnostic logs from within the editor.</td><td><a href="/pages/dfPAsmC4gI49gaBgUn6h">/pages/dfPAsmC4gI49gaBgUn6h</a></td></tr><tr><td><strong>Troubleshooting</strong><br>Common failure modes, diagnostic steps, and known issues.</td><td><a href="/pages/RoMMd8QlITNHZ4C7DbG4">/pages/RoMMd8QlITNHZ4C7DbG4</a></td></tr></tbody></table>

### Latest release

<code class="expression">space.vars.unreal\_plugin\_version</code> includes gesture and pointing animations triggered automatically by LLM-issued character actions, `UConvaiObjectComponent` for tagging level actors with live scene properties, gaze-driven attention with silhouette highlight and on-screen cursor, and fuzzy enum matching so minor AI spelling variations no longer drop action parameters. See [Release notes](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/release-notes.md) for the full changelog.

### Next steps

{% content-ref url="/pages/5oPvRJZZEVuIVMYZLYh8" %}
[Getting started](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started.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.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.