Ask or search…
K
Links

Quickstart

Load your personal Ready Player Me avatar in Unity in less than 10 minutes.

Before you begin

  • Make sure you have downloaded and installed Unity 2020.3.0f1 LTS or later.
  • For this to work, you need to have Git installed on your machine, which can be downloaded from here. After installation, you will also need to restart Unity.
  • Open your Unity Project
If you have an earlier version of the SDK installed, please refer to the migration guides.

1. Import the Ready Player Me Unity SDK

Import the package via Window -> Package Manager -> + icon -> Add Package from git URL.
Paste this git URL into the input field
https://github.com/readyplayerme/rpm-unity-sdk-core.git

2. Enter your subdomain

When you import the package for the first time, you will be greeted with our Setup Guide editor window to guide you through the setup process.
Here, you should enter the subdomain you get from Studio (Developer Dashboard). In the images below you can see where you get the Subdomain and App ID.
Open your Application
On the top you find the Application Details (Subdomain and App ID)
If you want to sign up later, you can also write "demo" in the field.
Then click the Next button.

3. Help us improve the SDK

Next, you can optionally adjust the analytics setting which is enabled by default.
Once you are happy with the settings, you can click the Finish Setup button.

4. Integration guide

In the last optional step, you will see the Integration Guide window. This window can be helpful to figure out the "next steps" in your integration journey.
The quickest way to see our Ready Player Me avatars in action is to open the quickstart scene by clicking the Load Quickstart Scene button.

5. Run the Quickstart scene

Open the QuickStart scene and click Play. You can see the default avatar and move around with it.
You can find the Quickstart Scene in Samples > Ready Player Me Core > [version] > QuickStart
Run the Quickstart Scene

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.
  1. 2.
    Paste the avatar URL of your avatar and click Load My Avatar.
Paste the avatar URL into the input field
  1. 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 old Unity Input system.

Check out how it is done

In the Inspector you can find the RPM Player GameObject with the ThirdPersonLoader on it. Open it in your IDE to check out how the avatar gets loaded into the scene.
Also, it's worth checking out the PersonalAvatarLoader UI to see how everything is connected.

Next steps

Next, you will learn in more detail how to: