Skip to main content

Getting Started

This guide covers setup and installation for integrating Inworld's AI SDK into Unreal Engine.

Installing the Inworld Unreal Engine SDK​

This video covers the initial installation and startup with Unreal Engine.

Installing Visual Studio​

To use the SDK, you must first have Visual Studio installed.

1. Download and Install​

To download and install Visual Studio, use the following link: Visual Studio Installer.

2. Specify Workloads Tools​

Once Visual Studio is installed, ensure you have the required Workloads and C++ tools Workloads and C++ Tools specified.

If you already have Visual Studio installed, you may open the installer and select Modify to add these workloads and tools.

Alternate IDEs​

You may use an alternative Integrated Development Enviroment (IDE) to Visual Studio, such as Rider, to install Inworld's Unreal Engine SDK. However, only Visual Studio is covered in this setup guide.

Creating a Project​

All projects using the Unreal Engine SDK must be C++ projects.

If needed, Blueprint projects can be converted to C++ projects by creating a Game Module with the same name as your project.

1. Open Launcher​

Open the Epic Games Launcher, and navigate to Unreal Engine --> Library.

Open Unreal Engine

Open or Create Project​

Either (1) open a project you've already created, or (2) create a new project by selecting your desired template.

This guide uses the First Person template found under Games --> First Person.

Create Game Template

Once created, your project folder is then populated as a Visual Studio .sln file, and an Unreal Engine .uproject file.

Game Directory

Install Inworld to the Project​

To install Inworld to your Unreal Project, you must have a Plugins folder in your project directory.

If this folder does not already exist, you need to create one before continuing.

1. Download Plugins​

To receive the Inworld Unreal SDK, contact your account manager.

SDK contains multiple Unreal Engine Plugins.

While you only need the InworldAI plugin to get started, the other plugins may help with integrating Inworld with common use cases. You can review the details of each Included Plugin to determine which may be the best fit for your project.

2. Stop Project Processes​

Ensure that your Unreal Engine project is not currently running by either closing the Editor or stopping the process from Visual Studio.

3. Place Plugins in Directory​

Place the desired Inworld plugins inside your projects Plugins directory.

If you have not installed Plugins before, you will need to create a "Plugins" folder in your project’s folder.

Install Plugin

4. Build Modules in Unreal​

Once the desired plugins are installed, double-click your projects .uproject file to open the Unreal Editor.

You are then prompted to build the modules. Select Yes.

Wait for the modules to be built. Afterwards, the Editor opens and you are ready to begin working.

Build Modules

Building from Visual Studio​

If building from Visual Studio, right-click your .uproject file and select Generate Visual Studio Project Files.

After a short while, your .sln file is updated.

Afterwards, open the Visual Studio Solution and build the project.