Documentation
Search
K

Importing a character from Convai Playground

Follow these instructions to bring a character from the Convai Playground into your Unity Project.
You can import the character created in the Convai Playground only in the Core, Complete, and Actions versions of the plugin.

Core Plugin

This is how you can import characters from the Convai Playground into your Unity Project.
In the Menu Bar, go the Convai > Character Importer.
Enter the Character ID and click Import.
Enter the character ID and click Import.
If you are unsure how to get the character ID, click the "How do I create a character?".
You can get the character ID from the Character Description.
The downloading will take a while. On successful download, you will see the character in the scene with the same GameObject as the character ID.
This character will automatically be set up with the basic Convai Setup including the ConvaiNPC Script and Out-Of-Box Animations.
If you are facing issues with the animations in your imported character, make sure to change the animation type of Ellen@IdleNew and Ellen@TalkingNew Animations in the Assets/Convai/Animations folder to Humanoid.
Change the animation type to 'Humanoid' and click 'Apply'.
Now you are ready to set up the character with transcriptions.
Follow the tutorial on importing custom characters below to see how you can set up the character with Transcriptions and Custom Animations.

Complete Plugin

For the Complete Plugin, the process of importing the character is different. First, we will want to create a scene that is compatible with the Convai. This scene needs to have the Convai Player Character and the Convai Transcript Canvas prefabs (or similar prefabs). For the Core Plugin, we do this manually, but for the Complete Plugin, the setup process is automated.
First, we will click on File > New Scene.
Click on New Scene in the File Menu
In the Dialogue that opens, select Convai Scene and click Create.
Click on Convai Scene and click create.
Then go the Convai > Character Importer.
Enter the Character ID and click Import.
Enter the character ID and click Import.
This will import your character completely set up with Lip Sync and basic animations.
The character is in the scene.
You can also see the prefab for the character in the Assets/Convai/Prefabs folder.
Character Prefab is in the Assets/Convai/Prefabs folder.
With this, you can use the Convai-powered RPM character in any scene in the project if you want.