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
  • How it works
  • Avatars
  • Avatar Creator
  • Ready Player Me Accounts
  • Ready Player Me API
  • SDKs
  • Ready Player Me Studio
  • Custom outfits
  • Conclusion
  • Next Steps

Was this helpful?

How Ready Player Me works

Learn how Ready Player Me works

PreviousWelcomeNextFAQ

Last updated 18 days ago

Was this helpful?

Ready Player Me is an avatar system for games, apps, and VR/AR experiences developed with Unity, Unreal Engine, React, native mobile solutions, and almost any stack that supports REST and PostMessage.

With little effort, you can integrate the Ready Player Me Avatar Creator into your app or game. Players can choose between thousands of customization options to create an avatar that represents their identity best. These avatars will then be served as fully skinned, rigged, and ready-to-animate 3D models to your development environment of choice.

For easy integration, you can use the SDKs (Unity, Unreal, React) or directly work with the APIs and/or iFrame Avatar Creator integration.

How it works

Learn in more detail about the components of the Ready Player Me System.

Avatars

The avatar is the center of Ready Player Me. Players can choose to create an avatar in their likeness from a selfie or a preset and customize it with various standard and custom assets.

For your application, you can choose between full-body and half-body avatars.

  • Full-body avatars are fully rigged, skinned, and game-ready 3D models of the whole person.

  • Half-body avatars consist of a head with a torso and hands, and are specifically designed for easy integration into VR games and apps.

GLB files

All avatars are stored as GLB files on Ready Player Me servers.

GLB is a standardized file format for sharing 3D data. A GLB avatar file includes information about the 3D model, materials, and skeleton.

URL

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.glb

The Avatar URL is public in that anyone with the URL can download its . While users can always download their avatars, you cannot modify a player's stored avatar without their permission.

You can retrieve an avatar 3D GLB model with desired performance and configuration settings for your application using the Avatars endpoint of the REST API. Here is an example of a URL that requests an avatar in the T pose.

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.glb?pose=T

2D Avatar Renders

You can request a 2D-rendered PNG image of an avatar for profile pictures and stickers. Change the file extension of the avatar URL from .glb to .png, as shown below.

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.png

You can customize the 2D renders. For example, you can request a smiling full-body render with a transparent background.

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.png?scene=fullbody-posture-v1-transparent&blendShapes[Wolf3D_Head][mouthSmile]=0.8

Avatar Creator

There are multiple options for creating an avatar and receiving an Avatar URL. All these methods use the same Assets and Avatar Endpoints of the REST API.

  • As a registered developer, you receive your own Avatar-Creator URL (https://[yoursubdomain].readyplayer.me), which you can integrate into your game or app via iFrame or WebView.

  • Developers can use the SDK to create their own customized Avatar Creator in Unity or Unreal Engine.

  • Developers can programmatically create an avatar using the Avatar Endpoints of the REST API.

Ready Player Me Accounts

Players who register with Ready Player Me receive a Ready Player Me Account and can

  • log in to Ready Player Me to manage their avatars and browse all Ready Player Me-enabled games and apps.

  • use their account credentials to log in to instances of the Avatar Creator on your and other developers' Avatar Creator URLs.

However, registering is not mandatory for players. For players who don't have a Ready Player Me user account, you can

  • create a guest account, which allows you to store and manage a list of their assets and avatars.

  • store their avatar URLs on your server. This offers players limited functionality, but allows them to play.

Ready Player Me API

Ready Player Me API is a RESTful service that allows you to create, modify, and request avatars, assets, and user accounts.

For example, you can request different levels of detail and make other performance adjustments on your avatar request.

https://models.readyplayer.me/6185a4acfb622cf1cdc49348.glb?lod=2&useDracoMeshCompression=true

SDKs

The Ready Player Me SDK for Unity and Unreal Engine, along with many examples and packages for web and native mobile development, makes integrating the Avatar Creator and loading avatars in your game or app much easier.

The SDKs allow you to

  • load avatars into your app or game via avatar URL into your project and at runtime.

  • integrate the Avatar Creator into your app or game.

  • tune performance of your app by using avatar configurations.

Ready Player Me Studio

Ready Player Me Studio is a developer workspace that helps you integrate Ready Player Me and manage your integration. After creating your Studio account, you will

  • get your own Avatar Creator URL.

  • modify the appearance and specifications of the Avatar Creator.

  • upload and manage your custom outfits and assets.

  • create an API Key to gain full access to all REST Avatar API endpoints.

  • enjoy the help of the Ready Player Me Copilot to guide you through the integration process.

Custom outfits

When you integrate with Ready Player Me, your players immediately have access to a large selection of assets for customizing their avatars.

You can enrich the default assets by adding your own custom and branded outfits. You can make them freely available or unlock them just for certain players. You upload and manage custom outfits via Studio or the Assets REST API.

Conclusion

With the Ready Player Me avatar system you have a complete solution for creating, managing, integrating, and customizing player avatars for your games and apps for web, desktop, mobile, VR and any other platform supported by Unity and Unreal Engine.

Next Steps

Every avatar is represented by a unique URL to its GLB file. Avatar URLs follow the structure https://models.readyplayer.me/[avatar-id].glb. You can use the URL below to download a sample avatar and view it in a GLB viewer (Try: ).

See all Endpoints in the .

to explore how it's done.

The Studio is available at

Try the QuickStart for / / and .

https://gltf-viewer.donmccurdy.com/
REST API Reference
Check out code samples
https://studio.readyplayer.me
Learn more about creating and managing custom outfits.
Ready to create a Developer account?
Unity
Unreal Engine
React
other platforms
Ready Player Me System Components (simplified)
Example of Tommy Hilfiger creating their custom outfits for their Tommy Parallel Project ()
https://www.tommyparallel.com/