Setting Up Unity Plugin

Follow these instructions to setup the Unity Plugin into your project.

The file structure belongs to the Core version of the plugin downloaded from the documentation.

Setting up Unity Plugin

In the Menu Bar, go the Convai > Convai Setup.

Go to, and sign in to your Convai account. Signing in will redirect you to the Dashboard. From the dashboard, grab your API key.

Enter the API Key and click begin.

This will create an APIKey asset in the resources folder. This contains your API Key.

Click the Convai NPC Amelia and add the Character ID (or you can keep the default character ID). You can get the character ID for your custom character from this page Create Character. Now you can converse with the character. The script is set up so that you have to go near the character for them to hear you.

Now you can test out the Convai Demo Scene and talk to the character present there. Her name is Amelia and she loves hiking!

You can open the Convai NPC Script to replicate or build on the script to create new NPCs.

Edit the ConvaiNPC.cs script directly to maintain compatibility with the Utility scripts.

Last updated