Skip to main content
Skip table of contents

Incorporating Externally Created ReadyPlayerMe Characters in Rapport

Configuring ReadyPlayerMe Characters for Rapport

When integrating ReadyPlayerMe (RPM) characters with Rapport, proper configuration is essential to ensure optimal animation performance and visual quality. This guide explains how to correctly prepare RPM characters created outside the Rapport platform.

Important Note

While we recommend using Rapport's built-in Character Creator for the most seamless RPM integration, we understand that you may have existing characters created directly through ReadyPlayerMe. This guide will help you properly configure these characters for use with Rapport's animation system.

Configuration Requirements

When downloading a ReadyPlayerMe character for use in Rapport, you must append specific parameters to the download URL to ensure compatibility with Rapport's animation system. Without these parameters, your character may exhibit limited or no motion capabilities.

Required URL Parameters

Add the following parameters to your ReadyPlayerMe character download URL:

CODE
?lod=0&useHands=true&textureAtlas=none&textureQuality=high&textureSizeLimit=1024&morphTargets=ARKit,Oculus

Parameter Breakdown

  • `lod=0`: Ensures full model detail, necessary for proper animation

  • `useHands=true`: Enables hand animations

  • `textureAtlas=none`: Prevents texture atlas generation for higher quality

  • `textureQuality=high`: Sets texture resolution to high quality

  • `textureSizeLimit=1024`: Defines maximum texture size

  • `morphTargets=ARKit,Oculus Visemes`: Includes necessary blend shapes for facial animations

Example URL

Integration Workflow

  1. How to Download Your RPM Character

  • Next to your ReadyPlayerMe Tab in the browser open a second tab

image-20241108-153839.png

In the ReadyPlayerMe tab a URL will be shown and look something like this

image-20241108-153945.png

In the second tab copy this URL

CODE
 https://models.readyplayer.me/[YOUR-AVATAR-ID].glb?lod=0&useHands=true&textureAtlas=none&textureQuality=high&textureSizeLimit=1024&morphTargets=ARKit,Oculus
image-20241108-154211.png


Copy your CharacterID from the ReadyPlayerMe tab and paste it into the [Your-Avatar-ID]

image-20241108-154437.png

This shows the URL with the appended configuration parameters. The CharacterID will relate to your specific character.

CODE
https://models.readyplayer.me/[Your-Avatar-ID].glb?lod=0&useHands=true&textureAtlas=none&textureQuality=high&textureSizeLimit=1024&morphTargets=ARKit,Oculus
  • Click enter/return to Download the GLB file

  1. Upload to Rapport

  • Navigate to the Assets section

  • Select "Characters"

  • Click "Create Character"

  • Choose "Upload an Existing Character file"

  • Select your downloaded GLB file

  • Name your character and save

Best Practices

  • Always verify the URL parameters are correctly formatted before downloading

  • Test your character's animations in Rapport's preview mode before deployment

  • Consider creating future characters directly through Rapport's Character Creator for optimal compatibility

Troubleshooting

If your character shows limited or no animation:

  • Verify all URL parameters are present and correctly formatted

  • Confirm the presence of both ARKit and Oculus Visemes morphTargets

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.