For the complete documentation index, see llms.txt. This page is also available as Markdown.

Troubleshooting

Find fixes for installation, API key, audio, lip sync, and connection problems in the Convai Unreal Engine plugin, plus log export and diagnostic guidance.

This section covers problems that occur at the plugin level: installation, authentication, session startup, microphone capture, general lip sync setup, and diagnostics. If the Convai Unreal Engine plugin connects successfully but one feature behaves incorrectly, start with that feature's troubleshooting page.

Not sure where to start? Open the Unreal Editor Output Log (Window > Output Log) and look for the first Convai error or warning. Use the log category as the route: LogConvai or LogConvaiEditor → Installation and plugin issues; ConvaiConnectionManagerLog, ConvaiSubsystemLog, or ConvaiChatbotComponentLog → Connection and API key issues; ConvaiAudioLog, ConvaiAudioStreamerLog, or ConvaiPlayerLog → Audio and microphone issues; ConvaiFaceSyncLog → Lip sync and animation issues. If no Convai category appears, start with Installation and plugin issues.

Troubleshooting categories

Feature-specific troubleshooting

Problems that occur after the plugin connects successfully — where a specific feature behaves incorrectly — are documented inside each feature's own section.

Feature
Troubleshooting page

Character actions

Dynamic context

Emotion

Troubleshoot emotion

Long-term memory

Narrative design

Scene metadata

Vision

Troubleshoot vision

Gaze attention

Lip sync

Troubleshoot lip sync

Next steps

When a problem is hard to diagnose from a single error message, enable verbose logging for the relevant category and inspect the Output Log. The diagnostics page also explains where Unreal writes logs and how to create a shareable support package from the Convai editor window.

Diagnostics and log export

Last updated

Was this helpful?