Installation and Setup

Learn how to install, set up, and run the Convai Unity Plugin Beta to integrate conversational AI characters directly within your Unity projects.

Introduction

The Convai Unity Plugin (Beta) allows you to seamlessly integrate Convai’s advanced conversational AI characters into your Unity projects. This plugin simplifies setup and provides a ready-to-run demo scene so you can start interacting with Convai-powered characters immediately.

---

Installation Guide

Follow these steps to install and configure the Convai Unity Plugin Beta.

1. Download the Plugin

Download the ZIP file provided below.

20MB

ConvaiUnityBeta_MR.zip

archive

Open

2. Extract the Package

Unzip the downloaded .zip file to your preferred location on your computer.

3. Create a New Unity Project

1. Open Unity Hub.

2. Click New Project.

3. Select your preferred Unity version (Unity 6 or later is recommended).

4. Choose the Universal 3D template.

5. Name your project and click Create Project.

Convai Unity Plugin supports Unity 2022 and above.

Unity will now create and open your new project.

4. Import the Convai Plugin Package

1. Once your project is open, navigate to the top menu and select Assets → Import Package → Custom Package.

2. In the file dialog, locate and select the Convai Unity Package you extracted from the .zip file.

3. Click Import to add the Convai Plugin to your project.

After the import completes, the Convai Plugin will be ready to configure within Unity.

---

Initial Setup

Once the project loads, Unity will automatically begin downloading additional files required for the plugin to function correctly. This download process ensures that the initial plugin package remains lightweight.

After the setup completes:

1. Go to the Top Menu → Convai.

2. Select Account from the dropdown.

3. In the API Key field, paste your Convai API key (you can copy it from your Convai Dashboard).

---

Running the Demo Scene

To verify that the plugin is correctly installed:

1. Navigate to: Assets/Convai/Demo/Scenes/Convai Sample Scene.unity

2. Open the scene.

3. Press the Play button in Unity.

You’ll see a default demo character appear in the scene. After a few seconds, the character will initialize and be ready for conversation. You can monitor the session initialization status through the Console Window.

---

Changing the Character ID

To use your own Convai character instead of the default demo character:

1. In the Hierarchy, select the ConvaiNPC GameObject.

2. In the Inspector, locate the ConvaiNPC component.

3. Replace the Character ID field with your own character’s ID.

Your new character will now load and respond in the same demo scene.

---

Conclusion

You’ve successfully set up and run the Convai Unity Plugin (Beta). From here, you can begin customizing the sample scene or integrate Convai characters directly into your own Unity environments.