LogoLogo
WebsiteBlogForumsSign up
  • Welcome
  • How Ready Player Me works
  • FAQ
  • 👩‍💻Integration Guides
    • Overview
    • Unity
      • Quickstart
      • Avatar Creator Integration
        • WebView Avatar Creator
          • Avatar Creator for Android & iOS
          • Avatar Creator for WebGL
        • Build your own Avatar Creator
          • Start with the sample
          • Elements
            • Asset Selection Element
            • Color Selection Element
            • Template Selection Element
            • Body Shapes Selection Element
            • Gender Selection Element
            • Avatar List Element
            • Photo Capture Element
            • Signup Element
            • Login Element
            • Logout Element
          • User Management
      • Load 2D Renders
      • Avatar Loader Window
      • Setup Multiplayer
      • Setup for XR (Beta)
        • Setup the Player Avatar
        • Setup Meta Movement SDK
        • Setup Final IK
        • Setup XR Hands
          • RpmHandDriver script
        • Facial Animations
        • VR Avatar Creator
      • Animations
        • Ready Player Me Animation Library
        • Mixamo Animations
      • Optimize
        • Avatar Configuration
        • Avatar Caching
        • Defer Agents
      • Code Samples
        • Loading 3D Avatars
        • Loading 2D Avatars
        • Avatar Creator (WebGL)
        • Avatar Creator (Desktop)
        • Avatar Creator (Mobile)
        • Distance-based LODs
      • Troubleshooting
        • Editor UI Window Issues
        • Avatar loading issues
        • iOS issues
        • WebGL issues
        • Firewall issues
        • Updating the SDK
          • Unity SDK 3.0.0 Migration guide
          • Unity SDK 4.0.0 Migration guide
          • Unity SDK 5.0.0
          • Unity SDK 7.0.0
          • WebView 2.0 Migration
        • Package installation issues
      • Help us improve the Unity SDK
      • FAQ for Unity
      • Early Access Features
    • Unreal Engine
      • Quickstart
        • Import SDK Manually
      • Avatar Creator Integration
        • Build your own Avatar Creator
          • Sample Structure
          • Customization Guide
        • WebView Avatar Creator
      • Load Avatars
      • Animations
        • Ready Player Me Animation Library
        • Loading Mixamo animations
        • Mannequin animation retargeting
        • Blender FBX export to UE
        • Oculus Lipsync integration
      • Optimize
        • Avatar configuration
        • Avatar caching
        • Avatar preloading
      • Code Samples
        • Unreal Engine 5 samples
        • Lyra project integration example
        • VR Avatars
        • Unreal Engine 4
      • Troubleshooting
        • Project compilation issues
        • Missing materials on built applications
        • Avatar loading issues
        • Animation issues
        • Unreal SDK breaking changes
        • Avatar lighting issues
        • Updating from earlier versions
          • Unreal SDK 3.0.0 Migration guide
        • Auto LOD issues
      • Help us improve the Unreal Engine SDK
      • FAQ for Unreal Engine
      • Early Access Features
    • React
      • Quickstart
    • React Native
    • iOS Native
    • Android Native
    • Web Integration
      • Quickstart
      • User Management
        • Guest Accounts
        • Account Linking
      • Avatar Creator integration
      • Optimize
    • API Integration
      • Quickstart
      • Custom Avatar Creator
      • User management
        • Ready Player Me Account
        • Anonymous Accounts
    • UX/UI Guidelines
      • Summary & quick tips
      • UX and UI guidelines and essentials
        • Foundation for good user experience
          • Layout
          • Colors
          • Typography
          • Icons
          • Dark mode and light mode
        • Mobile best practices
          • Layout
        • Making Ready Player Me feel native
          • Seamless Avatar Integration
          • Consistent Branding
          • Responsive Layout
          • Performance Optimization
        • Discoverability of the avatar editor
          • Onboarding tutorial
          • Clear navigation
          • Contextual Placement
  • 🖌️Customizing Guides
    • Studio (Developer Dashboard)
    • Avatar Creator Appearance
      • Avatar URLs
      • Avatar Shortcodes
    • Upload and Manage Custom Assets
      • Asset Manager in Studio
      • Configure in Studio
      • Manage custom assets using the API
      • Unlocking assets through API (Beta)
    • Create Custom Assets
      • Fullbody Outfits
        • Checking Skin Weights
      • Tops, Bottoms, Shoes
        • Editing templates
      • Hairstyle
      • Headwear
      • Facewear
      • Glasses
      • Hero Characters
      • Modeling Guidelines
  • 🔃API Reference
    • REST API
      • Authentication
      • Avatars
        • GET - 3D avatar
        • GET - 2D Render of an Avatar
        • GET - Metadata
        • PUT - Equip an asset
        • PUT - Unequip an asset
      • Assets
        • Asset Entity Properties
        • POST - Create Asset
        • GET - List Assets
        • PATCH - Update Asset
        • POST - Upload Asset Files
        • POST - Add Asset to Application
        • DELETE - Remove Asset from Application
        • PUT - Unlock asset for a user
        • PUT - Lock asset for a user
      • Users
        • POST - Create User
      • Auth
        • GET - Token
      • Changelog
    • Avatars
      • Full-body avatars
      • Full-body XR avatars
      • Half-body avatars
      • Morph targets
        • Apple ARKit
        • Oculus OVR LipSync
    • Avatar Creator
  • 🔉Support
    • Forums
    • Licensing & Privacy
Powered by GitBook
On this page
  • Before you begin
  • 1. Import the Ready Player Me Unity SDK
  • 2. Enter your subdomain
  • 3. Help us improve the SDK
  • 4. Integration guide
  • 5. Run the Quickstart scene
  • 6. Load your personal avatar into the scene
  • Check out how it is done
  • Next steps

Was this helpful?

  1. Integration Guides
  2. Unity

Quickstart

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

PreviousUnityNextAvatar Creator Integration

Last updated 7 months ago

Was this helpful?

Before you begin

  • Make sure you have downloaded and installed Unity 2021.3 LTS or later.

  • For this to work, you need to have Git installed on your machine, which can be downloaded . After installation, verify that the Git executable is in your PATH.

  • Restart Unity and open your Unity Project.

If you have an earlier version of the SDK installed, please refer to the .

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.

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.

6. Load your personal avatar into the scene

Click on Load my personal Avatar. This will open a new window.

  1. Create your personal avatar on your subdomain in a browser window and copy the Avatar URL

  1. Paste the avatar URL of your avatar and click Load My Avatar.

  1. 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:

Here, you should enter the subdomain you get from (Developer Dashboard). In the images below you can see where you get the Subdomain and App ID.

👩‍💻
Studio
integrate and customize the Avatar Creator in your game or app,
load 2D avatars (e.g., for profile pictures),
and how to animate your avatars.
from the Git download page
migration guides
Open your Application
On the top you find the Application Details (Subdomain and App ID)
You can find the Quickstart Scene in Samples > Ready Player Me Core > [version] > QuickStart
Run the Quickstart Scene
Copy the Avatar URL of your avatar.
Paste the avatar URL into the input field