> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inworld.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

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:

* Windows or macOS (For iOS build, mac is required).
* [Unity](https://unity.com/download): Version 2022.3 LTS or later (recommended: 6000.0.41 or newer)

<Note>
  We now supports windows, mac, Android, and iOS!
</Note>

## Installation

<Steps titleSize="h3">
  <Step title="Download the Inworld Agent Runtime">
    Download the Inworld Agent Runtime .unitypackage from <a href="https://storage.googleapis.com/assets-inworld-ai/unity-packages/InworldRuntime.0.7.5.unitypackage" target="_blank" rel="noopener noreferrer" download="">here</a>.
  </Step>

  <Step title="Import the package into your Unity project">
    If you don't already have an existing Unity project, create a new project. <br />
    You can simply drag the downloaded .unitypackage into your project,<br />
    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.

    <img src="https://mintcdn.com/inworldai/09jBaDxLDhFWSIuG/img/unity/framework/ImportPkg.png?fit=max&auto=format&n=09jBaDxLDhFWSIuG&q=85&s=d1cc1fbb60056e7aa3fbe28393a69564" alt="ImportPkg" width="1461" height="597" data-path="img/unity/framework/ImportPkg.png" />

    After the package is imported, you may see a prompt to restart the Unity Editor.

    If you're using Unity 6000 or newer, click **Yes** — no manual restart needed.

    Otherwise, click **No** and wait for the remaining assets to finish importing.

    <img src="https://mintcdn.com/inworldai/09jBaDxLDhFWSIuG/img/unity/framework/ImportPkg2.png?fit=max&auto=format&n=09jBaDxLDhFWSIuG&q=85&s=d427e1ff50c97bf1fe94b34c7fc3954d" alt="ImportPkg2" width="583" height="203" data-path="img/unity/framework/ImportPkg2.png" />
  </Step>

  <Step title="Add the dependencies to your Unity project">
    After you click **OK**, the package will install files into your project.

    Once those are imported, we will automatically download essential assets (Plugins and essential models) for you.
  </Step>

  <Step title="Set up the Inworld API key">
    After essential assets are downloaded, a dialog will appear prompting you to enter your API key.

    <img src="https://mintcdn.com/inworldai/4xYwu5DzJVkYL1AE/img/unity/framework/ImportPkg3.png?fit=max&auto=format&n=4xYwu5DzJVkYL1AE&q=85&s=744976ea83cd83323f4727b4fd925a7f" alt="ImportPkg3" width="693" height="489" data-path="img/unity/framework/ImportPkg3.png" />

    Once you've entered it, the system will check the current essential assets. If they are downloaded, they will appear as installed, as shown below.

    <img src="https://mintcdn.com/inworldai/09jBaDxLDhFWSIuG/img/unity/framework/ImportPkg4.png?fit=max&auto=format&n=09jBaDxLDhFWSIuG&q=85&s=1b2fbd9379c12ec5e99b9ec90daeb8d5" alt="ImportPkg4" width="687" height="488" data-path="img/unity/framework/ImportPkg4.png" />
  </Step>

  <Step title="Set up the Inworld API key">
    To use the Inworld Agent Runtime SDK with the cloud APIs, go to Assets/InworldRuntime/Resources.

    In the Inspector, add your Base64-encoded [Runtime API key](/node/authentication#runtime-api-key).

    <img src="https://mintcdn.com/inworldai/4VuegDBaCnR73Uxj/img/unity/framework/unity-api-key.png?fit=max&auto=format&n=4VuegDBaCnR73Uxj&q=85&s=7b4e18e638b47ee38dcedee1eff8b88c" alt="" width="960" height="809" data-path="img/unity/framework/unity-api-key.png" />
  </Step>

  <Step title="Play a demo">
    To get a first impression, we provide several demos. Any of the following will work:

    * [Assets/InworldRuntime/Scenes/Primitives/CharacterInteraction.unity](./demos/primitives/character)
    * [Assets/InworldRuntime/Scenes/Nodes/CharacterInteractionNode.unity](./demos/nodes/character)
    * [Assets/InworldRuntime/Scenes/Nodes/CharacterInteractionNodeWithJson.unity](./demos/nodes/json)

    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.

    <Note>
      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.

      <img src="https://mintcdn.com/inworldai/pDD5vvrZThONehMe/img/unity/framework/SampleCharData.png?fit=max&auto=format&n=pDD5vvrZThONehMe&q=85&s=e287cfc7440d8f0d9ea88289d0219f4a" alt="" width="1170" height="519" data-path="img/unity/framework/SampleCharData.png" />
    </Note>

    Here's the video about how it works.

    <iframe style={{ aspectRatio: '16 / 9', width: '100%', height: 'auto' }} src="https://drive.google.com/file/d/1Uxcy2m1ZLULMd-f6445TmvTJKcs6rdvl/preview" title="Unity AI Runtime - Get Start Sample" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen />
  </Step>
</Steps>

With these steps, you'll be all set to explore the capabilities of the Inworld Agent 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.

<CardGroup cols={2}>
  <Card title="Primitive Demos" href="/Unity/runtime/demos/primitives/overview">
    Explore demos showcasing the use of individual primitive modules, such as LLM, Speech-to-Text (STT), Text-to-Speech (TTS), etc.
  </Card>

  <Card title="Graph Node Demos" href="/Unity/runtime/demos/nodes/overview">
    See how each graph, edge and official node works in Unity's Graph Node demos, with ready-made graphs to explore.
  </Card>
</CardGroup>
