We suggest that you start by reviewing the sample scenes provided in our Unity Integration package before incorporating your own scene. This will help ensure a smooth integration process.
Here's a useful walkthrough of the demo scenes that are included with our Unity V3 SDK.
1. Importing the Package
There are three ways you can import the Inworld AI Unity SDK
unitypackage into your scene:
- Open Unity and go to
Custom Package. Next, select the
unitypackagethat you downloaded.
- Drag the
unitypackagethat you downloaded into Unity's Project panel.
- If you only have one instance of Unity running, then double-click the downloaded
When the Import Unity Package box appears, click the
⚠️ Note: It is recommended to delete the
Inworldfolder from your
Assetfolder if you have previously used an old version of the Inworld AI Unity SDK before importing the new package as it may not be compatible.
Based on the Unity package (Lite vs Full) you have downloaded, we have prepared different basic demos to help you get started.
Sample 2D Scene
Assets > Inworld > Inworld.Assets > Scenes, you will find a sample scene
Sample2D. You can interact with the character Innequin by 2D chat panel.
This sample scene is also included in InworldAI.Lite, only this sample is accessible.
⚠️ Note: By default, the contents under
Packagesin a Unity project are read-only. If your project references InworldAI.Lite solely through the Package Manager, please copy the
Import Text Mesh Pro
The Inworld AI Unity SDK requires "Text Mesh Pro", which is included with Unity but not imported by default. If you are opening any Unity scene inside Inworld Unity package, or opening the Inworld Studio Panel for the first time, please click
Import in the dialog for "Text Mesh Pro" if it appears.
Typing to the character
You can type sentences, and press the "Enter" or
Send button, to send a message to the character.
Speech to Text
Alternatively, you can hold down the
Record button, speak your message, and then release
Record to send a voice message.
⚠️ Note: If you are building a WebGL application, the microphone is not supported, so the
Push-to-talkfeature is not available either.
Innequin Sample Scene
Assets > Inworld > Inworld.Samples.Innequin > Scenes, you will find the 3D Innequin sample scene. This shows how Innequin is set-up with an InworldCharacter component, animation controller, and animations, as well as lipsync.
Talking to the Character
After pressing the Play button, please wait until the Inworld server has been connected. The avatar Innequin will wave at you, and then you can start speaking to the character.
⚠️ Note: If you change your audio input (i.e swap microphone input) during runtime, the new voice will not be recognized until you restart the app or re-enter Play Mode. Restarting the app will cause the change to take effect.
Typing to the Character
~ button to open or close the text input panel during runtime. While the text input panel is open, you can type sentences to the character.
Speech to Text
While the text input panel is open, you can hold the
Record button to record your sentences using your microphone. Release the button to send the recorded message.
4. Explore More Features
If you are looking to perform specific actions, check out the Change User Name tutorial.
For insights into the various sample scenes, delve into the Sample Scenes section.
If you want to discover more about Inworld's versatile features, explore the Unity Play Ground chapter.
And if you are eager to seamlessly integrate your custom characters into your game, take a look at the Integrate Inworld to your Scene guide.