Skip to main content
This guide covers setup and installation for Inworld’s Unity AI Runtime SDK.

​
Prerequisites

Before you get started, please make sure you have the following installed:
macOS and Linux support is coming soon. iOS and Android are planned for the future.

​
Installation

1

Import the package into your Unity project

If you don’t already have an existing Unity project, create a new project.
You can simply drag the downloaded .unitypackage into your project,
or, in your project, go to Assets > Import Package > Custom Package…, and select the .unitypackage you downloaded in Step 1.In the dialog box that pops up, click Import to finish importing the package.ImportPkgAfter the package is imported, a dialog may prompt you to restart the Unity Editor. Click Yes. You do not need to restart manually.ImportPkg2
2

Add the dependencies to your Unity project

After you click OK, the package will install files into your project.After those are imported, another dialog will appear indicating whether the required DLLs and AI models are missing.ImportPkg3Please download both. They are required to use the Unity AI Runtime.Once downloaded, they will appear as installed, as shown below.ImportPkg4
3

Set up the Inworld API key

To use the Inworld Runtime SDK with the cloud APIs, go to Assets/InworldRuntime/Resources.In the Inspector, add your Base64-encoded Runtime API key.
4

Play a demo

To get a first impression, we provide several demos. Any of the following will work:The demos above demonstrate a simple character interaction using our LLM, speech-to-text (STT), and text-to-speech (TTS) primitives.When you play a demo, you can converse with the character via text or audio (audio is push-to-talk only).Type your input, or hold the Record button to capture audio and release it to send.
For Primitives/CharacterInteraction: You will also need to set the character’s name, gender, role, voice, description, and motivation.When done, click Proceed. This creates a character for the duration of the session (it will not be saved).For the other two demos, the character data and prompt are stored under Assets/InworldRuntime/Data/GraphNodes/CharacterConversation/SampleCharacter.You can modify those ScriptableObjects to see the effect.
Here’s the video about how it works.
With these steps, you’ll be all set to explore the capabilities of the Inworld Runtime!

​
Next steps

You can check out the following demos for an overview of the features and modules available in the Inworld Unity AI Runtime.

Primitive Demos

Explore demos showcasing the use of individual primitive modules, such as LLM, Speech-to-Text (STT), Text-to-Speech (TTS), etc.

Graph Node Demos

See how each graph, edge and official node works in Unity’s Graph Node demos, with ready-made graphs to explore.