Unity Version

Skills and Knowledge

Before integrating the Convai SDK, you should be comfortable with the following:

1. Importing Packages: Know how to import external packages into a Unity project.

2. Unity Editor: Be proficient in navigating the Unity Editor interface.

3. Animations: Understand how to add and handle animations for assets.

4. Programming in C#: Have a basic experience programming Unity scripts in C#.

5. Script Integration: Be capable of adding scripts to a game object.

6. Building and Deployment: Know how to build and deploy an application to your chosen platform.

Having these skills will ensure a smooth integration and optimal use of the Convai Unity SDK in your projects.

Overview

Convai's Unity SDK provides you with all the tools you need to integrate conversational AI into your Unity projects. Convai offers specialized NLP-based services to build intelligent NPCs for your games and virtual worlds. Our platform is designed to seamlessly integrate with your game development workflow, enhancing the interactivity and depth of your virtual environments.

Key Features

• Conversational AI: Leverage advanced NLP capabilities to create NPCs that can understand and respond to player input in natural, engaging ways.

• Intelligent NPCs: Build characters with dynamic dialogue and behaviors that adapt to player actions and the game world.

• Easy Integration: Our SDK is designed for quick and simple integration with your Unity projects, allowing you to focus on creating compelling gameplay experiences.

• Cross-Engine Support: In addition to Unity, Convai supports other popular game engines, ensuring broad compatibility and flexibility for your development needs.

This is the Core version of the plugin. It has a sample scene for anyone to get started. This version of the plugin only contains the basic Convai scripts and Character Downloader.

Visit convai.com for more information and support.

Quick Setup Tutorial

Unity Version​

The minimum supported Unity version is 2022.3.x. Earlier versions may not be compatible.

Supported Platform​s

Disabling Assembly Validation

If you ever get an error that looks like this, disable the Assemble Version Validation in Project Settings > Player > Other Settings.

Ensure that Assembly Validation is disabled in Project Settings > Player > Other Settings.

Restart the Unity project after unchecking the box should fix the issue.

Common Issues (FAQ)

Q. I cannot see the Convai menu.

A. Please check if there are any errors in the console. Unity needs to be able to compile all the scripts to be able to display any custom editor menu options. Resolving all the console errors will fix this issue.

Q. There are a lot of errors on my console.

A. Primarily, two issues cause errors in the console that can stem from the Convai Unity Plugin. You can use the links below to fix them quickly.

Q. I am talking to the character, but I cannot see the user transcript and the character does not seem to be coherently responding to what I am saying.

A. This may indicate issues with the microphone. Please ensure that the microphone is connected correctly. You also need to ensure that the applications have permission to access the menu.

Q. The animations for my characters are looking very weird.

A. The animation avatar that we are using might be incompatible with the character mesh. Fixing that can solve the issue.

Q. There are two Settings Panel Buttons in Mobile Transcript UI.

A. If you are using Unity 2021, unexpected prefab variant issues may arise. This is because Unity Mobile Transcript UIs are variants of the main transcript UI prefab. With changes in the Prefab system in Unity 2022, it works correctly in Unity 2022. If you are using Unity 2021, you may encounter issues with prefabs. You can remove the redundant Settings Panel Button to address this problem.

Q: The lipsync is very faint or not visible.

A: The animations that we are using may be modifying facial animations. Editing the animations to remove facial animations should fix any issues related to lipsync.

A: The script also needs the avatar to not be mapped to the jaw bone to be manipulate the jaw bones itself.

Q: I'm facing security permission issues using the grpc_csharp_ext.bundle DLL inside the Unity Editor on MacOS

A: macOS's strict security measures can block certain external unsigned DLLs. To address this, you can manually allow the DLL in "Security & Privacy" settings, modify Gatekeeper's settings through Terminal, ensure correct file permissions for the DLL, check its settings in Unity, and update the Mac Configuration in Unity's Player Settings

Q: I'm not able to talk to my character after building my Unity project for macOS (Intel64+Apple Silicon builds), especially on Intel Macs

A: The issue is rooted in the grpc_csharp_ext.bundle used in Unity for networking. This DLL has separate versions optimized for Intel and Apple Silicon architectures. When trying to create a Universal build that serves both, compatibility problems arise, especially on Intel Macs. Presently, the best solution is to use Standalone build settings specific to each architecture.

Error Index

Follow this Table to navigate to our most common errors.

If the default animations that ship with the animator look bugged such that the hand seems to intersect with the body, it could indicate an issue with the wrong animation avatar being selected.

You can easily fix that by heading to the character's animator component and assigning the correct animator to the Avatar field.

The correct animation will look something like this. The hands should not intersect the body.

Our plugin has various scripts and dependencies that use Newtonsoft Json. If Newtonsoft Json is missing from the plugin, it could lead to a large number of errors as shown below:

Ensure that NewtonSoft.Json is present in your packages. Go to your project folder.

Then navigate to Packages folder. In the Packages folder. Click on manifest.json. A json file containing the project dependacies should open up.

Add the Newtonsoft Json Package on top.

The final manifest.json should look like this.