Import and configure the Unreal Engine SDK for your project.

Before you begin

  • Sign in to Studio (Developer Dashboard) and get the Subdomain and App ID. This will allow you to create and load an avatar in your domain at a later step.
  • Verify that your Unreal Version is Unreal Engine 4.27, Unreal Engine 5, or higher.
  • Make sure that you have Visual Studio installed, it should be because Unreal Engine depends on it. In order for Unreal Engine to work properly you might need to install the following packages from the Visual Studio Installer: Desktop development With C++, Game development with C++, .NET desktop development.

1. Download and import the SDK into Project

Follow the steps to download and import the Ready Player Me SDK and its dependency glTFRuntime to your project.
  1. 1.
    Create a new project, in case you don't have an existing project, where you want to integrate Ready Player Me Avatars.
  2. 2.
    Close the Unreal editor.
  3. 3.
    Create a directory in your project folder and name it Plugins.
  4. 4.
    Download and import the Ready Player Me SDK Into your Project. Therefore, go to the Ready Player Me release page on GitHub, download the Source code (zip) file, unpack it into the Plugins folder, and name the unpacked folder ReadyPlayerMe. Make sure that the ReadyPlayerMe folder doesn't have a nested folder.
  5. 5.
    Next, download and import the glTFRuntime plugin into your project. Therefore, go to the release page on GitHub, download the Source code (zip) file, unpack it into the Plugins folder, and name the unpacked folder glTFRuntime. Make sure that the glTFRuntime folder doesn't have a nested folder.
  6. 6.
    Open your project in Unreal Engine.
  7. 7.
    You should receive the Missing Modules popup. Click Yes, and wait for the Editor to open with your project. THIS CAN TAKE SEVERAL MINUTES, PLEASE WAIT. See Troubleshooting if you get an error and your project didn't build.
  8. 8.
    You successfully imported the Ready Player Me Unity SDK and the glTFRuntime plugin.
(Optional) There is also another option to add the ReadyPlayerMe plugin as a submodule to the existing git project.

2. Enter your subdomain

When you integrate the SDK for the first time, you will be greeted with our Setup Guide editor window to guide you through the setup process.
Please enter your own subdomain you got from Studio.
If you want to sign up later, click the checkbox next to the "I don't have an account. Use demo subdomain instead" field.
Then click the Next button.

3. Help us improve the SDK

Next, you can enable/disable analytics. This helps us improve the SDKs.
Click the Finish Setup button.

4. Integration guide

The integration guide will help you find the most essential material to integrate Ready Player Me successfully.
The quickest way to see our Ready Player Me avatars in action is to open the Quickstart map by clicking the Load Quickstart Map button.

5. Run the Quickstart Map

Open the QuickStart map and click Play. You can see the default avatar and move around with it.

6. Load your personal avatar into the scene

Click on Load my personal Avatar. This will open a new window.
  1. 1.
    Create your personal avatar on your subdomain in a browser window and copy the Avatar URL
    Copy the Avatar URL of your avatar.
  2. 2.
    Paste the avatar URL of your avatar and click Load My Avatar.
  3. 3.
    After loading is complete, you will see your avatar.
The third-person controller is currently designed to work with a keyboard and mouse using the deprecated Unreal Input system. This is done intentionally to support Unreal Engine 4.27.

Explore Ready Player Me plugin content

  • In the Content Browser click Settings (cogwheel icon on the far right)(View Options in UE4). Make sure Show Plugin Content and Show Engine Content are both checked.
  • In the Content Browser, expand Plugins and scroll or use search until you find the ReadyPlayerMe Content folders.

Next steps

Next, you will learn in more detail how to:
If you have trouble creating your project, see Troubleshooting for straightforward solutions.