For the complete documentation index, see llms.txt. This page is also available as Markdown.

Import and run sample scenes

Import the bundled sample scenes and verify the SDK is installed and connected correctly before building your own scene.

The Convai SDK for Unity ships with three sample scenes. Running one is the fastest way to confirm your installation, API key, and audio setup are working before you build your own scene.

Sample
Description

Basic Sample

Core setup and interaction flow with Convai_Char_Robot, a non-humanoid character

LipSync Sample

High-quality character Sofia with real-time lip sync, plus a debug hub for inspecting emotion, dynamic context, and vision state during Play mode

Multi-Character Sample

A shared-room sample demonstrating multiple Convai characters, interaction targeting, transcript UI, and runtime roster changes

The steps for locating the samples differ depending on how you installed the SDK.

1

Open Package Manager

In the Unity Editor, open Window > Package Manager. In the top-left dropdown, select In Project, then select Convai SDK for Unity from the list.

2

Import a sample

In the detail panel on the right, click the Samples tab. Click Import next to the sample you want to run.

Unity copies the sample assets into Assets/Samples/Convai SDK for Unity/<version>/. A new folder appears under Assets/Samples/ in the Project window.

3

Open the scene

In the Project window, navigate to the imported sample folder and open its .unity scene file.

1

Locate the samples

When installed via the Asset Store, all sample scenes are imported into your project automatically. In the Project window, navigate to:

Assets/Convai SDK For Unity/Samples/

Three folders are present: BasicSample, LipSyncSample, and MultiCharacterSample.

2

Open the scene

Open the .unity scene file inside the sample folder you want to run.

Once the scene is open:

1

Enter Play Mode

Press Play. The Unity Console logs the following lines as the SDK initializes:

  • [ConvaiRuntime] Started successfully — SDK initialized all internal services

  • [RoomConnectionRuntimeAdapter] Room connection succeeded (mode=create). — the room connected to Convai

Speak into your microphone. The character responds with voice and text output.

If no response appears and the Console shows warnings, check Validate your setup for a diagnostic checklist.

In the LipSync Sample, the Sample Debug Hub panel is already in the scene. Click its Emotion, Context, or Vision buttons in the Game view to open a drawer showing live state while the character talks.

Sample render pipeline notes

Sample scenes are built with the Universal Render Pipeline (URP). If your project uses a different render pipeline, materials may appear pink after import. Convert the materials to match your active render pipeline using Edit > Rendering > Materials, then select the appropriate conversion option for your pipeline.

Next steps

Now that you have confirmed the SDK is working, learn what each scene component does before building your own setup.

Scene components reference

Last updated

Was this helpful?