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
  • Current Limitations
  • Getting started
  • 1. Enable XR Avatars for your application
  • 2. Create your first XR Avatar
  • 3. Check out the VR Demo Project
  • How it is done
  • Setup your Player Avatar Object in Unity
  • Inverse Kinematics (IK)
  • Setup XR Hands
  • Meta Movement SDK (as an alternative to Final IK and LipSync)
  • Facial Animations
  • Creating a VR Avatar Creator

Was this helpful?

  1. Integration Guides
  2. Unity

Setup for XR (Beta)

Integrate Ready Player Me in your Virtual Reality (VR/XR) Unity experience.

PreviousSetup MultiplayerNextSetup the Player Avatar

Last updated 8 months ago

Was this helpful?

Before you begin

  • Make sure you check out our regular to set up and get familiar with Ready Player Me Unity SDK.

  • Developer Account in

  • Read the current

Current Limitations

  • are currently not supported.

  • For NPCs, we recommend using default avatars, as they have better compatibility with existing animation libraries (see ).

  • Larger (heavyset, plus size) have in some cases clipping issues.

Getting started

1. Enable XR Avatars for your application

In XR applications, to enhance the deformation of arms and hands in embodied VR/AR experiences, you can opt for an alternative rig instead of the standard fullbody avatars. This upgraded rig includes twist bones in the arms and a redesigned hand model, coupled with an OpenXR-compliant hand rig.

To enable Fullbody-XR avatars, you first need to enable them in the Developer Studio. Simply open your application and set the body type to Fullbody-XR.

2. Create your first XR Avatar

To load your XR Avatar into the project, you need to create one fist. While you have not implemented the Avatar Creator in your Unity game, you can use the Web Avatar Creator to create one.

You need to create a new avatar on your subdomain after the change of your application to Full Body-XR has been made. So go to https://[yoursubdomain].readyplayer.me and create a new avatar. Alternatively, you can use the methods in the Ready Player Me SDK to create a new avatar from a template.

Existing avatars will not be converted to fullbody-xr avatars.

3. Check out the VR Demo Project

On GitHub, you can find a VR Demo Project that shows you all the functionality you need to get started.

  • Setting up the player avatar with inverse kinematics (using Final IK)

  • Avatar Creator in VR

  • Facial animations using Oculus Lip Sync

  • Interactions and Hand Posing


How it is done

Learn in more detail, how every feature is implemented.

Setup your Player Avatar Object in Unity

The player avatar object will contain all the logic to control the player avatar. Learn how to set it up and how to do mesh-transfer, to load a custom avatar.

Inverse Kinematics (IK)

Setup XR Hands

Unity has a package to drive your avatar's hand movements - XR Hands. You can use it, to implement controller interactions or hand tracking. XR Hands package is compatible with Meta Quest, Vision Pro and many interaction libraries.

Meta Movement SDK (as an alternative to Final IK and LipSync)

Instead of using Final IK for body animations and Oculus Lipsync for facial animations, you can utilize Meta Movement SDK, if you are developing for Meta Quest Platform. With the additional compatibility package, the setup is easy and straightforward.

Facial Animations

Virtual social presence in VR is critical to creating a fluid experience. Ready Player Me avatars provide capabilities to help ensure that those social interactions are more believable and engaging.

Creating a VR Avatar Creator

The Ready Player Me SDK allows you to build your own Avatar Creator so that you can tailor the player-facing UI and UX to fit your app’s brand and visual style. It comes equipped with hundreds of customization options, including outfits, tops, bottoms, shoes, hairstyles, and other cosmetics. And you can go beyond that, by creating your custom outfits.

Check out our or our , which has all of the functionality described below implemented.

->

If you do not have special requirements for the IK solution, we recommend using . It is widely used and offers great documentation and tutorials. However, it is a paid plugin, that needs to be purchased on the Unity Asset Store.

->

->

->

👩‍💻
VRDemo example project
VR Application in the meta store
Setup the Player Avatar
Final IK from Rootmotion
Setup Final IK
Setup XR Hands
-> Setup Meta Movement SDK
Setup the VR Avatar Creator in your game
Quickstart
Studio
Hero outfits
Animations
Body shapes
Read more about XR Avatars.
Go to Studio
Limitations
-> Setup eye blinking, eye gazing, facial tracking, and lip sync.