Feature map

Find the right Convai Unreal Engine plugin feature, guide, or reference page for any development goal, indexed by use case.

Use this map when you know what you want to build but are not sure which feature, component, or guide covers it.

Getting started

I want to...	Guide	Documentation
Check what I need before installing the plugin	Prerequisites	Prerequisites
Install the plugin into my Unreal project	Installation	Installation
Configure my Convai API key	API key setup	Configure API key
Understand what each component in the scene does	Component reference	Scene components
Add my first AI character to a scene	Scene setup	Add your first character
Set up a MetaHuman character with the plugin	MetaHuman	Set up a MetaHuman character
Set up a Reallusion character with the plugin	Reallusion	Set up a Reallusion character
Configure microphone input and platform permissions	Microphone	Configure microphone
Tune the character's voice audio output	Character audio	Configure character audio
Choose between push-to-talk and hands-free input	Input mode	Configure conversation input
Display a chat or subtitle UI for the conversation	Chat UI	Add the chat UI
Verify my scene is configured correctly before shipping	Validation	Validate your setup

Features

I want to...	Feature	Documentation
Let my character execute in-scene commands (Move To, Follow, custom)	Character actions	Character actions
Push live world state and events into character knowledge at runtime	Dynamic context	Dynamic context
Show facial emotion on my character driven by the AI response	Emotion	Emotion
Make characters remember each player across sessions	Long-term memory	Long-term memory
Trigger scripted conversation branches and sections by name from Blueprint	Narrative design	Narrative design
Tag level actors so characters are aware of and can act on them	Scene metadata	Scene metadata
Stream camera frames so characters can see and describe the scene	Vision	Vision
Route the object under the player's gaze as context to the active character	Gaze attention	Gaze attention
Add real-time lip sync driven by character speech	Lip sync	Lip sync

Reference

I want to...	Reference	Documentation
Browse documented Blueprint component, utility, and shared data pages	Blueprint reference	Blueprint reference
Look up the Chatbot component Blueprint surface	Chatbot component	Convai Chatbot component
Look up the Player component Blueprint surface	Player component	Convai Player component
Look up the Object component Blueprint surface	Object component	Convai Object component
Look up microphone and audio capture functions	Audio functions	Microphone and audio capture
Look up utility Blueprint functions	Utility functions	Utility functions
Look up all enums, structs, and data types	Data types and enums	Data types and enums
Sign in, browse sample content, or export logs from the editor	Editor window	The Convai editor window
Check which Unreal Engine versions are supported	Engine versions	Unreal Engine versions
Check which platforms are supported for packaging	Platform support	Unreal Engine platform support matrix
Check which character rigs are compatible (MetaHuman, Reallusion)	Rig support	Character rig support

Troubleshooting

I want to...	Topic	Documentation
Fix connection or API key errors	Connection issues	Connection and API key issues
Fix audio or microphone problems	Audio issues	Audio and microphone issues
Fix lip sync or facial animation problems	Animation issues	Lip sync and animation issues
Fix plugin installation or build errors	Installation issues	Installation and plugin issues
Export diagnostic logs or configure logging	Diagnostics	Diagnostics and log export

Next steps

Getting started