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

​
Prerequisites

​
Install Unreal AI Runtime

1

Download Unreal AI Runtime

Download Inworld Runtime, which contains the core Inworld Runtime functionality.We also recommend downloading our template plugins, which are pre-built implementations of common use cases that can be immediately plugged into your game. See Templates for a description of each of the template plugins.
2

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

Disable NNEDenoiser and NNERuntimeORT

For the following platforms, you will need to disable the NNEDenoiser and NNERuntimeORT plugins before adding the Inworld Runtime plugin:
  • Windows: Unreal Engine 5.4 and 5.5 (not required for 5.6)
  • Mac: Unreal Engine 5.4 – 5.6.
  • Linux: Unreal Engine 5.4 – 5.6.
Inworld’s VAD (voice activity detection) component is not compatible with these plugins. On Windows, if these plugins are not disabled, VAD will not be available. On Mac and Linux, the NNERuntime Module will hang indefinitely while attempting to load if you fail to disable these plugins before adding the Plugins folder.To disable them:
  • In Unreal, select Edit from the top menu list and then Plugins.
  • In the Plugins menu, disable NNEDenoiser and NNERuntimeORT. Plugins menu
4

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

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

Set up the Inworld API key

To use the Inworld 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 into the Runtime API Key field.After you add your API key, to capture telemetry (e.g., logs, traces), you will need to restart Unreal.
7

Play a template

Play the Chat template which illustrates how to have a simple audio to audio conversation using the Inworld 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.
8

Explore your traces in Portal

Go to your workspace in Portal and explore the traces that were generated while you were playing the Chat Template.
With these steps, you’ll be all set to explore the capabilities of the Inworld Runtime!

​
Next steps

For more advanced explorations, check out: