Quickstart

Before you begin

• Sign in to Studio (Developer Dashboard) and copy your subdomain. This will allow you to create and load an avatar in your domain at a later step.

• 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

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 edit the UI field demo and replace it with your own subdomain.

e.g yourappname

If you are not a partner or do now have your own subdomain please click the tickbox next to the "I don't have an account. Use demo subdomain instead" field.

Then click the Next button.

3. Avatar configuration

Next, you are required to set your avatar configuration that will be used when you load an avatar.

Click the Avatar config editable field to select the configuration you want to use. To see the configs included by default you will need to click the eye icon image the top right.

Alternatively, you can create your own Avatar Config, you can do this by right-clicking in the Assets tab and going to Create > Ready Player Me > Avatar Configuration

Then adjust the settings as you need, more information on avatar configuration can be found here.

4. Help us improve the SDK

Finally, in the last step of the setup process, you can optionally adjust the analytics setting which is enabled by default.

Once you are happy with the settings you can click the Open QuickStart Scene which will trigger the import of the Quick Start sample folder.

5. Open the runtime example scene

Go to Assets -> Samples-> Ready Player Me Avatar Loader-> [VERSION_NUMBER]-> QuickStart -> QuickStart and double-click to open the scene.

4. Load your personal avatar

Next, you need an avatar URL. If you don't have one, you can create one in your own subdomain https://[your-subdomain].readyplayer.me/avatar. You can get your subdomain from Studio.

After creating your avatar, copy the URL.

Return to the Quick Start Scene.

In the hierarchy, select the RPM Player game object and open the Third Person Loader Component.

Paste the Avatar URL into the Avatar Url Property.

5. Run your project

Click Play and wait a moment for your avatar to load and animate with a basic third-person controller setup.

Next steps

Next, you will learn in more detail how to:

• load 3D avatars,

• load 2D avatars (e.g., for profile pictures),

• integrate and customize the Avatar Creator in your game or app,

• and how to animate your avatars.