Setup for XR (Alpha)

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

Before you begin

Current Limitations

Fullbody-XR avatars are in Alpha. Please do not use this feature in a production environment, as there might be breaking changes coming.

  • You can not enable XR Avatars by yourself. Please contact Ready Player Me Support with your App-ID and Subdomain. In case you use your subdomain for a production app, please create a new application in Studio for testing the XR avatars and retrieve a new App-ID and subdomain.

  • Currently, only modular outfits are supported (separate tops, bottoms, shoes). Fullbody outfits and hero avatars currently do not work. We will support that later this year.

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

  • Body shapes are not tested in VR.

  • We will publish a VR sample application soon. Currently, you need to rely on the documentation only.

Fullbody-XR avatars

In XR applications, to enhance the performance and realism of embodied VR experiences, you can opt for an alternative rig instead of the standard avatars. This upgraded rig includes twist bones in the arms and a redesigned hand model, coupled with an OpenXR-compliant hand rig. These features enable more lifelike and accurate movements of the hands and arms for the player avatar. Moreover, the alternative rig is designed to be compatible with a wide range of third-party libraries, ensuring a versatile and comprehensive integration for developers seeking to enrich their VR interactions.

The bone-axis orientation in the hands and fingers of the avatar differs from the rest of the body to adhere to the Open XR standard. This distinction may introduce certain constraints when using existing animation libraries, such as Mixamo or Ready Player Me Animations. However, this specific orientation is crucial for ensuring that Ready Player Me avatars are compatible with Open XR-based hand tracking and interaction libraries, facilitating more accurate and realistic hand movements and interactions within VR environments.

Create XR Avatars

Once you configure the body type to 'fullbody-xr' in your application through the Developer Studio (a change that must be implemented by Ready Player Me Support), you can then load the 'fullbody-xr' avatars into your project.

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

You need to create a new avatar on your subdomain after the change of your application 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.


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.

-> Setup the Player Avatar

Inverse Kinematics (IK)

If you do not have special requirements for the IK solution, we recommend using Final IK from Rootmotion. 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.

-> Setup Final IK


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.

-> Setup eye blinking, eye gazing, facial tracking, and lip sync.


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.

-> Setup the VR Avatar Creator in your game

Last updated