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

# Unreal Agent Runtime Quickstart

This guide covers setup and installation for Inworld’s Unreal Agent Runtime SDK.

<Note>
  **Upgrading to 1.0?** See the [Migration Guide](/unreal-engine/runtime/migration-guide) for a summary of breaking changes.
</Note>

## Supported Platforms

Windows · Mac · Linux · Android · iOS

## Prerequisites

<Tabs>
  <Tab title="Windows">
    * [Inworld account](https://platform.inworld.ai/signup) and [API Key](/unreal-engine/runtime/authentication)
    * [Unreal 5.4 - 5.7](https://www.unrealengine.com/en-US/download)
    * [Visual Studio with .NET Desktop Development and .NET 8.0 and 9.0 Runtime](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2022)
      * [Follow the Unreal Specific Guide](https://learn.microsoft.com/en-us/visualstudio/gamedev/unreal/get-started/vs-tools-unreal-install)
      * [.NET 8.0 and 9.0 Runtime](https://dotnet.microsoft.com/en-us/download)
  </Tab>

  <Tab title="Mac">
    * Mac with Apple Silicon (x86\_64 not supported)
    * [Inworld account](https://platform.inworld.ai/signup) and [API Key](/unreal-engine/runtime/authentication)
    * [Unreal 5.4 - 5.7](https://www.unrealengine.com/en-US/download)
    * [Xcode 15.4 or higher](https://developer.apple.com/download/all/?q=xcode%2015.4)

    <Warning> Some newer versions of Xcode may not be compatible with older Unreal Engine versions. Make sure you have a compatible version.  </Warning>
  </Tab>

  <Tab title="Linux">
    * [Inworld account](https://platform.inworld.ai/signup) and [API Key](/unreal-engine/runtime/authentication)
    * [Unreal 5.4 - 5.7](https://www.unrealengine.com/en-US/download)
      * [Follow the Unreal Linux Development Quickstart](https://dev.epicgames.com/documentation/en-us/unreal-engine/linux-development-quickstart-for-unreal-engine)
  </Tab>
</Tabs>

## Install Unreal Agent Runtime

<Steps titleSize="h3">
  <Step title="Download Unreal Agent Runtime">
    <span>
      <a href="https://assets.inworld.ai/unreal-plugin/runtime/InworldRuntime.zip" data-inw-tevent="Clicked &#x22;Download Inworld Agent Runtime&#x22;" data-inw-tevent-property="Unreal" download="" target="_blank" rel="noopener noreferrer">
        **Download Inworld Agent Runtime**
      </a>

      , which contains the core Inworld Agent Runtime functionality.
    </span>

    We also recommend <a href="https://assets.inworld.ai/unreal-plugin/runtime/InworldTemplates.zip" target="_blank" rel="noopener noreferrer" download="">**downloading our template plugins**</a>, which are pre-built implementations of common use cases that can be immediately plugged into your game. See [Templates](/unreal-engine/runtime/templates) for a description of each of the template plugins.
  </Step>

  <Step title="Create a new Unreal project">
    Create a new C++ game project in Unreal (5.4+). *Any of the games templates will work, but we recommend the Blank Template.*

    <img src="https://mintcdn.com/inworldai/oiEP3AP43FH6T441/img/unreal/runtime/01.png?fit=max&auto=format&n=oiEP3AP43FH6T441&q=85&s=770d0cf8a4d00475ab9112d3939a9499" alt="" width="1600" height="1153" data-path="img/unreal/runtime/01.png" />
  </Step>

  <Step title="Add to Plugins">
    Close Unreal. Create a Plugins folder in your project’s root directory. Extract the contents of each of the zip files you downloaded in step 1, and place them into this new folder.

    <img src="https://mintcdn.com/inworldai/jZEUfsfalhUT2QRk/img/unreal/runtime/sdk-plugins.png?fit=max&auto=format&n=jZEUfsfalhUT2QRk&q=85&s=fc8f867c2cb01d068c5180dfa8428a00" alt="" width="689" height="363" data-path="img/unreal/runtime/sdk-plugins.png" />
  </Step>

  <Step title="Launch your project">
    In the root folder of your project, click on the .uproject file to launch your project. You will be prompted to rebuild the newly added plugin modules.
  </Step>

  <Step title="Set up the Inworld API key">
    To use the Inworld Agent Runtime SDK with cloud APIs, open the Unreal Editor and, in the top menu bar, go to Edit > Project Settings > Plugins > Inworld > ApiKey and paste your Base64 [Runtime API key](/unreal-engine/runtime/authentication) into the Runtime API Key field.

    <img src="https://mintcdn.com/inworldai/oiEP3AP43FH6T441/img/unreal/runtime/06.png?fit=max&auto=format&n=oiEP3AP43FH6T441&q=85&s=6a0aa3fe4699716e0553ddce3821b8b9" alt="" width="1489" height="777" data-path="img/unreal/runtime/06.png" />

    After you add your API key, to capture telemetry (e.g., logs, traces), you will need to restart Unreal.
  </Step>

  <Step title="Play a template">
    Play the Chat template which illustrates how to have a simple audio to audio conversation using the Inworld Agent Runtime & Character.

    1. Open the settings menu in the Content Browser within Unreal.
    2. Enable the option for “Show Plugin Content”.
    3. In the Content Browser, navigate to: `/Plugins/InworldChat`
    4. Double-click on the Chat.umap.
    5. Click the Play-in-Editor button (alt+p) to launch your level.

           <img src="https://mintcdn.com/inworldai/cjOBLSaT-WmNEJqi/img/unreal/runtime/chat-level.png?fit=max&auto=format&n=cjOBLSaT-WmNEJqi&q=85&s=0cac7afb59323b8899cfc691a82aea86" alt="" width="1556" height="944" data-path="img/unreal/runtime/chat-level.png" />
  </Step>

  <Step title="Explore your traces in Portal">
    Go to your workspace in [Portal](https://platform.inworld.ai/) and explore the traces that were generated while you were playing the Chat Template.

    <img src="https://mintcdn.com/inworldai/RkgB7_KBZERTW3L0/img/unreal/runtime/portal-trace.png?fit=max&auto=format&n=RkgB7_KBZERTW3L0&q=85&s=44178f302c37afc1c7a13b5525dfa7c3" alt="" width="2041" height="1082" data-path="img/unreal/runtime/portal-trace.png" />
  </Step>
</Steps>

With these steps, you'll be all set to explore the capabilities of the Inworld Agent Runtime!

## Next steps

For more advanced explorations, check out:

* [Understand how the Chat template works](/unreal-engine/runtime/templates/chat)
* [Runtime reference](/unreal-engine/runtime/runtime-reference/overview) - Class definitions and functions
* [Learn how to use the Graph Editor](/unreal-engine/runtime/graph-editor)