Rapport Unreal Viewer Plugin Overview.
The Rapport Unreal Plugin (RUV) is an Unreal Engine plugin that connects your Rapport project and drives character performances.
Through a direct connection between your Rapport project and Unreal Engine, the plugin enables real-time character animation and communication.
How It Works:
Audio can be input via a microphone, sound wave asset, etc. and this will then be sent to Rapport.
In response, Rapport returns synchronized speech and animation data.
This data drives your character’s movements and facial expressions, ensuring that the character’s speech and performance match the spoken words.
By using the Rapport Unreal Plugin, you can create lifelike, interactive digital characters for games, simulations, and virtual experiences.
Project Creation – Unreal Plugin
Rapport’s new project creation workflow for Unreal Plugin applications simplifies setup and gives you full control over key components like character rigging, voice, and AI behavior.
Step-by-Step Setup
Step 1 – Create Your Workspace
Your workspace is the home for your projects and assets. If you haven’t created one yet, go to your dashboard and click Create Workspace.
Step 2 – Start a New Project
Inside your workspace, click the large Create New Project button.
Step 3 – Choose Application Type: Unreal Plugin
Select Unreal Plugin as the application type to start a project designed for integration with Unreal Engine.
Step 4 – Project Setup
The left-hand menu (see the Quick Start Guide) will now guide you through all the necessary configuration options:
Project Setup – Give your project a name and choose a starting template.
Character Config – Select the model rig type for your project (e.g., Metahuman).
Language – Choose the language your character will speak.
Voice – Choose from TTS providers and preview how your character will sound.
AI – Select the AI model and optionally customise the behavior using prompts or advanced fields.
✅ Once all required fields are configured, your session preview will begin automatically.
Previewing the Project Before Deployment
While Unreal projects don’t show full character animation in the preview:
You can preview the voice selected
A visual speech cue is displayed when testing voice output
This helps confirm the voice behavior before deploying to Unreal.
Save and Integrate (Unreal)
When your configuration is complete:
Click Save and Integrate to publish the project
This unlocks Deploy Token Management
You’ll also see the instructional video on plugin setup
Deploy Token Management
The Rapport Unreal Plugin connects your Unreal Engine project with the Rapport platform—enabling lifelike, voice-driven character interactions powered by Rapport’s AI and animation systems.
To authenticate and connect the two environments, you’ll need to generate a Deploy Token.
What Are Deploy Tokens?
Deploy Tokens link your published Rapport project to your Unreal project. Only active and valid tokens can be used in the Rapport Unreal Viewer Plugin.
How to Manage Deploy Tokens
After clicking Save and Integrate, navigate to the Integration section:
Create a New Token
Enter a name
Optionally set an expiration date
Click Create New Token
Delete or Deactivate Tokens
Remove tokens you no longer use
Only active tokens are displayed in the plugin
Set Expiry Dates
Define how long a token should remain active
Useful for temporary access or time-boxed deployments
Final Integration Step
Once your token is created, follow the instructions in the Rapport Unreal Viewer User Guide to complete setup inside Unreal Engine.
Part 2: Connecting the Plugin and Driving a Character
This video walks through the technical setup of the Rapport Unreal Viewer Plugin inside Unreal Engine, including installation, setup, and real-time character animation.
Topics Covered:
✔ Installing the Rapport Unreal Viewer Plugin in Unreal Engine – Download and install the plugin.
✔ Enabling & Setting Up the Plugin – Activating the plugin in Unreal Engine.
✔ Creating & Configuring a Rapport Session Component – Establishing a connection between Unreal and Rapport.
✔ Syncing Voice Data with Real-Time Animation – Driving character animation with real-time speech input.
By the end of this tutorial, your Rapport Project will be fully integrated with Unreal Engine, allowing characters to animate in real time based on voice input.
Next Steps
After following the above steps, you’ll have a fully integrated character in Unreal Engine that responds to voice input and performs real-time facial animation. If you need additional guidance, check out our documentation or contact our support team. 🚀