# Table of Contents - [Welcome | Ready Player Me](#welcome-ready-player-me) - [How Ready Player Me works | Ready Player Me](#how-ready-player-me-works-ready-player-me) - [Overview | Ready Player Me](#overview-ready-player-me) - [FAQ | Ready Player Me](#faq-ready-player-me) - [WebView Avatar Creator | Ready Player Me](#webview-avatar-creator-ready-player-me) - [Unity | Ready Player Me](#unity-ready-player-me) - [Avatar Creator Integration | Ready Player Me](#avatar-creator-integration-ready-player-me) - [Elements | Ready Player Me](#elements-ready-player-me) - [User Management | Ready Player Me](#user-management-ready-player-me) - [Avatar Creator for WebGL | Ready Player Me](#avatar-creator-for-webgl-ready-player-me) - [Avatar Loader Window | Ready Player Me](#avatar-loader-window-ready-player-me) - [Build your own Avatar Creator | Ready Player Me](#build-your-own-avatar-creator-ready-player-me) - [Setup Multiplayer | Ready Player Me](#setup-multiplayer-ready-player-me) - [Ready Player Me Animation Library | Ready Player Me](#ready-player-me-animation-library-ready-player-me) - [Email Protection | Cloudflare](#email-protection-cloudflare) - [Changelog | Ready Player Me](#changelog-ready-player-me) --- # Welcome | Ready Player Me [hashtag](https://docs.readyplayer.me/ready-player-me/#select-your-integration-method) Select your integration method -------------------------------------------------------------------------------------------------------------------------- [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity) ![Cover](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FLlqB2aDuxhilnMs6ku1w%252Funity.png%3Falt%3Dmedia%26token%3Daf38b952-ab81-4165-8ff6-4355d70b75cf&width=490&dpr=4&quality=100&sign=4e835a96&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/#unity-sdk) Unity SDK [](https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine) ![Cover](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FFZ8rzyP6goVe3eD7CbKP%252Funreal.png%3Falt%3Dmedia%26token%3D7b406af8-1f3d-42e7-8abd-c4d171462921&width=490&dpr=4&quality=100&sign=e5bdcd13&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/#unreal-sdk) Unreal SDK [](https://docs.readyplayer.me/ready-player-me/integration-guides/react) ![Cover](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FFLHwi21Iru4vHpwX22R2%252Freact.png%3Falt%3Dmedia%26token%3D37e46a2f-6e56-4b2f-9589-cb5f00d0fabc&width=490&dpr=4&quality=100&sign=b09fc60&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/#react) React [](https://docs.readyplayer.me/ready-player-me/integration-guides/react-native) ![Cover](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FjI0pws9bX6iUqRcpDZLZ%252Freact-native.png%3Falt%3Dmedia%26token%3Ddec22cc0-e4e0-49e2-abe2-48c0d0a1aec9&width=490&dpr=4&quality=100&sign=b58271ce&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/#react-native) React Native [](https://docs.readyplayer.me/ready-player-me/integration-guides/quickstart) ![Cover](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FJPSm0HFchPXyCYxVBsuc%252Fios.png%3Falt%3Dmedia%26token%3Db9cc8766-7a61-4cee-a0ab-e859b6a44c6c&width=490&dpr=4&quality=100&sign=61ba35a8&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/#ios-native) IOS Native [](https://docs.readyplayer.me/ready-player-me/integration-guides/quickstart-1) ![Cover](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FUZw4fJ33eXkPutsbfK34%252Fandroid.png%3Falt%3Dmedia%26token%3D37a8ef04-ab7b-4e48-ae72-edaa0bbdf44b&width=490&dpr=4&quality=100&sign=bedc2cc8&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/#android-native) Android Native [](https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration) ![Cover](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252F6eE2N6Kn5nRg9IYduOhd%252Fhtml5.png%3Falt%3Dmedia%26token%3Dbfe2a2c1-c9ed-401c-b4c4-5a3d450ce10c&width=490&dpr=4&quality=100&sign=588b25ae&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/#web) Web [](https://docs.readyplayer.me/ready-player-me/integration-guides/api-integration) ![Cover](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252Frc0E2bfvcscI4sil3Ogv%252Frestapi.png%3Falt%3Dmedia%26token%3D466bcc2e-37f0-414a-8431-aebfbf3a302b&width=490&dpr=4&quality=100&sign=3a760b75&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/#integration-api) Integration API [hashtag](https://docs.readyplayer.me/ready-player-me/#customization-guides) Customization guides ------------------------------------------------------------------------------------------------------ [](https://docs.readyplayer.me/ready-player-me/customizing-guides/studio-developer-dashboard) **Developer Studio** Manage and customize your content. [](https://docs.readyplayer.me/ready-player-me/customizing-guides/avatar-creator) **Avatar Creator** Configure and customize the Avatar Creator. [](https://docs.readyplayer.me/ready-player-me/customizing-guides/upload-and-manage-custom-outfits) **Upload and Manage Custom Assets** Upload custom outfits and make them available in your apps. [](https://docs.readyplayer.me/ready-player-me/customizing-guides/create-custom-assets) **Create Custom Assets** Create different types of assets, including outfits, hairstyles and more. [hashtag](https://docs.readyplayer.me/ready-player-me/#api-reference) API reference ---------------------------------------------------------------------------------------- [](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api) **REST API** [](https://docs.readyplayer.me/ready-player-me/api-reference/avatars) **Avatars** [](https://docs.readyplayer.me/ready-player-me/api-reference/avatar-creator) **Avatar Creator** [hashtag](https://docs.readyplayer.me/ready-player-me/#support) Support ---------------------------------------------------------------------------- [](https://forum.readyplayer.me/) **Forums** Ask questions and search answers. [NextHow Ready Player Me workschevron-right](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me) Last updated 8 months ago Was this helpful? --- # How Ready Player Me works | Ready Player Me 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. ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FC5bWhGj8J3pyVdCDiv8i%252FDocs2.png%3Falt%3Dmedia%26token%3Ddcd48fb2-651d-42ca-a696-0b39a71a8915&width=768&dpr=4&quality=100&sign=103cac5c&sv=2) Ready Player Me System Components (simplified) [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#how-it-works) How it works ------------------------------------------------------------------------------------------------------------- Learn in more detail about the components of the Ready Player Me System. ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#avatars) 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. ![Ready Player Me Fullbody Avatars](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FnykTYZnQjWwzwvGTnKwq%252FCleanShot%25202023-09-07%2520at%252018.27.13.png%3Falt%3Dmedia%26token%3D6c4f4308-d2fe-412e-8971-61cbafbca47d&width=300&dpr=4&quality=100&sign=5ea338e5&sv=2)![Ready Player Me Halfbody Avatars](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252F9eLg9g9c0aVzno703s9O%252FCleanShot%25202023-09-07%2520at%252018.27.45.png%3Falt%3Dmedia%26token%3Dcde489d8-7b1d-4556-9f0b-b7625d6dbcb6&width=300&dpr=4&quality=100&sign=e783e6f2&sv=2) #### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#glb-files) 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. #### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#url) URL 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: [https://gltf-viewer.donmccurdy.com/arrow-up-right](https://gltf-viewer.donmccurdy.com/) ). The Avatar URL is public in that anyone with the URL can download its GLB file. 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. #### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#id-2d-avatar-renders) 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. You can customize the 2D renders. For example, you can request a smiling full-body render with a transparent background. ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FKci2ZwJbgCTaSM5stz91%252Fimage.png%3Falt%3Dmedia%26token%3D400250c7-2915-42e8-8bc1-33deff05074c&width=300&dpr=4&quality=100&sign=8da85149&sv=2)![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252F9WiMUa9aKWk68DJxQbGC%252Fimage.png%3Falt%3Dmedia%26token%3D34ad4909-cfaa-4e61-8ae7-7bad2c119685&width=300&dpr=4&quality=100&sign=bf33a84a&sv=2) ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#avatar-creator) 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. ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#ready-player-me-accounts) 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. ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#ready-player-me-api) 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. See all Endpoints in the [REST API Reference](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api) . ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#sdks) 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. [Check out code samplesarrow-up-right](https://readyplayer.me/developers/code-samples) to explore how it's done. ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#ready-player-me-studio) 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. The Studio is available at [https://studio.readyplayer.mearrow-up-right](https://studio.readyplayer.me/) ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FGQ98Eh9qpLqm3tE3Z1Kd%252FCleanShot%25202023-08-29%2520at%252014.26.01.png%3Falt%3Dmedia%26token%3D41ea6a1e-d725-4800-a8d8-a44f9ca5f004&width=300&dpr=4&quality=100&sign=b1f7a7b6&sv=2) ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#custom-outfits) 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. [Learn more about creating and managing custom outfits.](https://docs.readyplayer.me/ready-player-me/customizing-guides/upload-and-manage-custom-outfits) ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FICjR650nX2PDi2BU7tbR%252Fhilfiger_custom_outfit.png%3Falt%3Dmedia%26token%3D85f5d71d-e3a6-4e59-8add-69ecf427d0ce&width=768&dpr=4&quality=100&sign=cd94abeb&sv=2) Example of Tommy Hilfiger creating their custom outfits for their Tommy Parallel Project ([https://www.tommyparallel.com/arrow-up-right](https://www.tommyparallel.com/) ) ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#conclusion) 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. ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FLPES6Ji5aeY42BIwGvey%252FReady%2520Player%2520Me%2520-%2520How%2520it%2520Works%2520-%2520Components%2520Full.png%3Falt%3Dmedia%26token%3D4166c8f2-4e5d-4c5f-988d-84a9e905298a&width=300&dpr=4&quality=100&sign=4ad9de61&sv=2) ### [hashtag](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#next-steps) Next Steps [**Ready to create a Developer account?**arrow-up-right](https://studio.readyplayer.me/getting-started) Try the QuickStart for [**Unity**](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/quickstart) / [**Unreal Engine**](https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine) / [**React**](https://docs.readyplayer.me/ready-player-me/integration-guides/react) and [**other platforms**](https://docs.readyplayer.me/ready-player-me/integration-guides/overview) **.** [PreviousWelcomechevron-left](https://docs.readyplayer.me/ready-player-me) [NextFAQchevron-right](https://docs.readyplayer.me/ready-player-me/faq) Last updated 8 months ago Was this helpful? * [How it works](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#how-it-works) * [Avatars](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#avatars) * [Avatar Creator](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#avatar-creator) * [Ready Player Me Accounts](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#ready-player-me-accounts) * [Ready Player Me API](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#ready-player-me-api) * [SDKs](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#sdks) * [Ready Player Me Studio](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#ready-player-me-studio) * [Custom outfits](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#custom-outfits) * [Conclusion](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#conclusion) * [Next Steps](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me#next-steps) Was this helpful? sun-brightdesktopmoon Copy https://models.readyplayer.me/6185a4acfb622cf1cdc49348.glb Copy https://models.readyplayer.me/6185a4acfb622cf1cdc49348.glb?pose=T Copy https://models.readyplayer.me/6185a4acfb622cf1cdc49348.png Copy https://models.readyplayer.me/6185a4acfb622cf1cdc49348.png?scene=fullbody-posture-v1-transparent&blendShapes[Wolf3D_Head][mouthSmile]=0.8 Copy https://models.readyplayer.me/6185a4acfb622cf1cdc49348.glb?lod=2&useDracoMeshCompression=true sun-brightdesktopmoon --- # Overview | Ready Player Me You can integrate Ready Player Me avatars and the Avatar Creator into all environments that support the web standards REST and postMessage. For Unity and Unreal Engine, we provide an SDK to make integration convenient. For many other platforms, we support you with integration examples (see Web and Native Integration). [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity) **Unity Integration** Integrate Ready Player Me avatars with your game using the Unity SDK. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine) **Unreal Engine Integration** Integrate Ready Player Me avatars with your game using the Unreal Engine SDK. [](https://docs.readyplayer.me/ready-player-me/integration-guides/react) **React** Integrate Ready Player Me avatars in your React app. **React Native Integration** Integrate Ready Player Me Avatar Creator in your React Native app. **iOS Native** Integrate Ready Player Me Avatar Creator in your iOS app. **Android Native** Integrate Ready Player Me Avatar Creator in your Android app. [](https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration) **Web Integration** Use Ready Player Me APIs to natively integrate avatars with your web, iOS, Android, or custom environment. [](https://docs.readyplayer.me/ready-player-me/integration-guides/api-integration) **API Integration** Integrate Ready Player Me in all stacks that support REST. [PreviousFAQchevron-left](https://docs.readyplayer.me/ready-player-me/faq) [NextUnitychevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity) Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # FAQ | Ready Player Me chevron-rightHow do I create a Ready Player Me avatar?[hashtag](https://docs.readyplayer.me/ready-player-me/faq#how-do-i-create-a-ready-player-me-avatar) If you're looking to create a Ready Player Me avatar compatible with thousands of apps and games, use the Ready Player Me Avatar Creator. All avatars created on our website are under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 Internationalarrow-up-right](https://creativecommons.org/licenses/by-nc-sa/4.0/) license, so you can use them for non-commercial projects (as long as you credit us). [**Create an avatar ->**arrow-up-right](https://readyplayer.me/avatar) chevron-rightHow much does it cost to use Ready Player Me avatars and the SDK?[hashtag](https://docs.readyplayer.me/ready-player-me/faq#how-much-does-it-cost-to-use-ready-player-me-avatars-and-the-sdk) Ready Player Me avatars and the Ready Player Me Avatar SDK are free to use for developers and end users. chevron-rightWhat are the licensing terms for the Ready Player Me avatars and the SDK?[hashtag](https://docs.readyplayer.me/ready-player-me/faq#what-are-the-licensing-terms-for-the-ready-player-me-avatars-and-the-sdk) See [Licensing](https://docs.readyplayer.me/ready-player-me/support/terms-of-use) . chevron-rightCan I use the Ready Player Me Avatar SDK for a commercial project for free? [hashtag](https://docs.readyplayer.me/ready-player-me/faq#can-i-use-the-ready-player-me-avatar-sdk-for-a-commercial-project-for-free) Yes! All you need to do is to sign up as a developer. **Note that you are not allowed to mint our avatars as NFTs.** [**Sign up as a developer ->**arrow-up-right](https://studio.readyplayer.me/getting-started) chevron-rightHow can you offer the SDK for free? [hashtag](https://docs.readyplayer.me/ready-player-me/faq#how-can-you-offer-the-sdk-for-free) We are currently focused on user growth – not monetization. However, in the future we want to create a digital asset store where artists, brands, and developers will be able to sell customization options for avatars. The revenue will be split between us, asset creators, and Ready Player Me partners. chevron-rightDo you collect photos from people who create avatars? [hashtag](https://docs.readyplayer.me/ready-player-me/faq#do-you-collect-photos-from-people-who-create-avatars) We use the photo uploaded by a user solely to create the avatar as also stated in the Privacy Policy and Terms of Use. * [**Full Privacy Policy**arrow-up-right](https://drive.google.com/file/d/1dJ4dKguCS_PVxcd0iuTyrFLgm3AUrtdL/view) * [**Full Terms of Use**arrow-up-right](https://drive.google.com/file/d/1ER3gBvx1UwXMDiOaZk8akzPmO6LAFfTp/view) chevron-rightWhat types of avatars do you support?[hashtag](https://docs.readyplayer.me/ready-player-me/faq#what-types-of-avatars-do-you-support) Ready Player Me can be used to create half-body avatars suitable for VR applications as well as full-body avatars for applications that support them. chevron-rightWho is using Ready Player Me today?[hashtag](https://docs.readyplayer.me/ready-player-me/faq#who-is-using-ready-player-me-today) Ready Player Me is integrated into throusands of apps, games and VR experiences. [**View All Partners ->**arrow-up-right](https://readyplayer.me/apps) chevron-rightDo users have to use readyplayer.me or can I offer an in-app Avatar Creator? [hashtag](https://docs.readyplayer.me/ready-player-me/faq#do-users-have-to-use-readyplayer.me-or-can-i-offer-an-in-app-avatar-creator) You can do both! Create a subdomain for your customized Avatar Creator and implement the Ready Player Me Avatar Creator into your app. [Follow the Integration Guides.](https://docs.readyplayer.me/ready-player-me/integration-guides/overview) chevron-rightWhat platforms do you support?[hashtag](https://docs.readyplayer.me/ready-player-me/faq#what-platforms-do-you-support) Ready Player Me avatars can be created on any device capable of WebGL rendering, that is, all modern web browsers. For developers, we provide integration guidelines and SDKs for integrating Ready Player Me avatars into the web, Unity, Unreal Engine, or any other platform supporting postMessage and REST technology. See [Integration Guides](https://docs.readyplayer.me/ready-player-me/integration-guides/overview) . chevron-rightWhat are the requirements to access Ready Player Me behind a (corporate) firewall or on a private network?[hashtag](https://docs.readyplayer.me/ready-player-me/faq#what-are-the-requirements-to-access-ready-player-me-behind-a-corporate-firewall-or-on-a-private-netw) The following domains need to be resolvable from your client in order to access the Ready Player Me avatar creation and customization web interface and to be able to download the resulting avatars. chevron-rightCan I add custom content to Ready Player Me?[hashtag](https://docs.readyplayer.me/ready-player-me/faq#can-i-add-custom-content-to-ready-player-me) Yes, you can. See [Upload and Manage Custom Outfits](https://docs.readyplayer.me/ready-player-me/customizing-guides/upload-and-manage-custom-outfits) . chevron-rightI have a feature request or found a problem![hashtag](https://docs.readyplayer.me/ready-player-me/faq#i-have-a-feature-request-or-found-a-problem) You can connect with us and the community on [Developer Forumsarrow-up-right](https://forum.readyplayer.me/) . [PreviousHow Ready Player Me workschevron-left](https://docs.readyplayer.me/ready-player-me/what-is-ready-player-me) [NextOverviewchevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/overview) Last updated 8 months ago Was this helpful? Was this helpful? sun-brightdesktopmoon Copy readyplayer.me cname.vercel-dns.com avatars.readyplayer.me d1a370nemizbjq.cloudfront.net models.readyplayer.me api.readyplayer.me sun-brightdesktopmoon --- # WebView Avatar Creator | Ready Player Me The WebView Avatar Creator is a web-based, device-agnostic, and ready-to-use way of integrating the avatar creation and editing process into your game. In this guide, you will learn how to integrate it for different deployment targets. circle-info You have various customization options for the Avatar Creator. See the [**Avatar creator customization guide**](https://docs.readyplayer.me/ready-player-me/customizing-guides/avatar-creator) **.** ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FRJTpJYcblJOYTmpfwrJJ%252F1643632284-avatar-creation%2520%281%29.gif%3Falt%3Dmedia%26token%3Dd681af9e-5fe9-4cd1-ba41-50f23d936858&width=768&dpr=4&quality=100&sign=5958f70d&sv=2) Ready Player Me Avatar Creator [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator#avatar-creator-integration) Avatar Creator integration -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Follow the steps in the integration guide for your platform. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-android-and-ios) **Avatar Creator for Android and iOS** Use the WebView component to include the Avatar Creator in your Android or iOS game. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-webgl) **Avatar Creator for WebGL** Use a web overlay to integrate the avatar creator in your WebGL game. [PreviousAvatar Creator Integrationchevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator) [NextAvatar Creator for Android & iOSchevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-android-and-ios) Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Unity | Ready Player Me To help you quickly set up the Ready Player Me package in your Unity project, we've created a concise 5-minute video guide. This quick start tutorial will walk you through the essential steps to get you up and running in no time. Watch the video below to get started: [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity#download-sdk) Download SDK -------------------------------------------------------------------------------------------------------------- There are two options to download our latest Long-Term Support version of the Unity SDK: 1. **Unity Asset Store:** You can download our SDK from the [Unity Asset Storearrow-up-right](https://assetstore.unity.com/packages/tools/game-toolkits/ready-player-me-avatar-and-character-creator-259814) . Using this method, you will receive notifications for each version update and be emailed when a new version is released. 2. **Ready Player Me Unity SDK GitHub Repository:** You can visit our [Unity SDK GitHubarrow-up-right](https://github.com/readyplayerme/rpm-unity-sdk-core) page to access the latest release and install it via the Unity Package Manager. [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity#guides) Guides -------------------------------------------------------------------------------------------------- [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/quickstart) **1\. Quickstart** Load your first personal avatar into Unity in less than 10 minutes. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator) **2\. Avatar Creator** Integrate and customize the ready-to-use Avatar Creator into your game. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/animations) 3**. Animations** Learn, how to add animations and facial expressions to your avatars. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/optimize) 4**. Optimize** Optimize avatars depending on your available computing and graphics power. [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity#more-on-the-unity-sdk) More on the Unity SDK -------------------------------------------------------------------------------------------------------------------------------- [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer) **Multiplayer** Learn how to set up Ready Player Me for multiplayer in Unity. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-for-xr-beta) **Setup for XR** Integrate Ready Player Me in your virtual reality (VR/XR) unity experience. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/load-2d-renders) **Load 2D Renders** Learn how to load 2D renders of your avatar. E.g. for profile pictures. [PreviousOverviewchevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/overview) [NextQuickstartchevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/quickstart) Last updated 1 year ago Was this helpful? * [Download SDK](https://docs.readyplayer.me/ready-player-me/integration-guides/unity#download-sdk) * [Guides](https://docs.readyplayer.me/ready-player-me/integration-guides/unity#guides) * [More on the Unity SDK](https://docs.readyplayer.me/ready-player-me/integration-guides/unity#more-on-the-unity-sdk) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Avatar Creator Integration | Ready Player Me You have two options to provide Avatar customization for your users. * Integrate the plug-and-play **Web Avatar Creator via Webview**. * **Build your own Avatar Creator in Unity** using the Unity SDK. The following sections will help you decide whether to use the WebView approach or build your own. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator#integrate-the-web-avatar-creator-via-webview) Integrate the Web Avatar Creator via WebView The Web Avatar Creator runs inside a browser (WebView) within your application. It communicates via PostMessage with your application (e.g. returns the Avatar URL). ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FQkVXe7oB9Wz6T5mPhpZB%252FCleanShot%25202023-11-08%2520at%252010.27.34.gif%3Falt%3Dmedia%26token%3De27fd292-61b8-492a-8b66-d050c9fbe544&width=768&dpr=4&quality=100&sign=a8fc8ea8&sv=2) **Benefits** * You will always have the latest Ready Player Me Avatar Creator features without any coding necessary. * Plug and Play. * Integration can be done in a few minutes. **Limitations** * No editor support. * Works only with Android, iOS, and WebGL. * Limited customization options ([e.g. choose theme colors](https://docs.readyplayer.me/ready-player-me/customizing-guides/avatar-creator) ). [Read more on WebView Avatar Creator for Unity](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator) . ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator#build-your-own-avatar-creator-in-unity) Build your own Avatar Creator in Unity With the help of the SDK, you can create your own Avatar Creator in Unity. You can make use of all the assets as well as the backend of Ready Player Me. Check out the examples to see all available features. ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FwArRbL7Sy5oO4vRV9bgb%252FCleanShot%25202024-02-06%2520at%252015.38.14.gif%3Falt%3Dmedia%26token%3Db47407f4-b1e0-4dc4-b52c-956848ca206a&width=768&dpr=4&quality=100&sign=94ae23e&sv=2) Avatar Creator made in Unity **Benefits** * Fully customizable UX/UI as it is natively built in Unity. * Runs on all platforms that Unity supports * Includes ready-to-use examples. * You can remove (and add) features as you like. **Limitations** * Takes more work to integrate. * You carry the maintenance load when Ready Player Me introduces new features. [Read more on how to create your own Avatar Creator in Unity](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator) [PreviousQuickstartchevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/quickstart) [NextWebView Avatar Creatorchevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator) Last updated 1 year ago Was this helpful? * [Integrate the Web Avatar Creator via WebView](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator#integrate-the-web-avatar-creator-via-webview) * [Build your own Avatar Creator in Unity](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator#build-your-own-avatar-creator-in-unity) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Elements | Ready Player Me ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FwArRbL7Sy5oO4vRV9bgb%252FCleanShot%25202024-02-06%2520at%252015.38.14.gif%3Falt%3Dmedia%26token%3Db47407f4-b1e0-4dc4-b52c-956848ca206a&width=768&dpr=4&quality=100&sign=94ae23e&sv=2) Customized Game UI circle-exclamation Ready Player Me is a free product. To keep it free to use, please provide the following mandatory elements in your core flows: **Login Element:** Allows users to log in with their existing Ready Player Me credentials and use their avatars and/or purchased assets in your application. See [Login Element](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/login-element) . **Signup Element:** Non-Ready Player Me users will be notified to sign up at Ready Player Me and use their created avatar in hundreds of virtual worlds. The user can skip or start the asynchronous signup process by providing their email address. See [Logout Element](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/logout-element) . ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements#elements) Elements [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/asset-selection-element) **Asset Selection Element** Customize the asset selection scroll view, the buttons, and the highlighter. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/color-selection-element) **Color Selection Element** Customize the skin-tone selector. **Template Selection Element** Learn how to create an avatar from the template selection and customize the UI. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/body-shapes-selection-element) **Body Shapes Selection Element** Learn how to let your users choose one of four bodyshapes [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/gender-selection-element) **Gender Selection Element** Customize the gender selection element. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/avatar-list-element) **Avatar List Element** Store multiple avatars for your user and access them via the customizeable UI. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/photo-capture-element) **Photo Capture Element** Learn how to create an avatar from a selfie and customize the element. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/signup-element) **Signup Element** Give your users the opportunity to use their avatars in hundreds of apps and games. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/login-element) **Login Element** Learn how let your users login with their existing Ready Player Me account. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/logout-element) **Logout Element** Learn how to logout your users. [PreviousStart with the samplechevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/quickstart) [NextAsset Selection Elementchevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/asset-selection-element) Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # User Management | Ready Player Me All users management is through personal or anonymous Ready Player Me accounts. State management for user management is done through the `AuthManager` class. `AuthManager` is responsible for creating, loading, and updating the user state necessary for avatar creation and updates. `AuthManager` incorporates a private static session storage, which can be modified by calling specific methods to update the state. The following sections explain how to use these methods effectively. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/user-management#creating-and-logging-in-of-anonymous-users) Creating and logging in of anonymous users Users who don't have an existing Ready Player Me account can have an anonymous account so that you can still store a list of avatars and assets for them (for your app or game only). Copy public static async Task LoginAsAnonymous() This method creates an anonymous account for the user, enabling them to begin creating avatars without the need for Ready Player Me signup. The anonymous user's data is stored in the `userSession` variable. Copy public static void SetUser(UserSession session) This method retrieves a previous session from the `session` parameter. Sessions can be stored in any preferred location. The example below demonstrates storing the session in `PlayerPrefs` and retaining it even after the user closes the application. **Example** Copy private async void Start() { if (PlayerPrefs.HasKey("StoredSession")) { AuthManager.SetUser(JsonUtility.FromJson(PlayerPrefs.GetString("StoredSession"))); } else { await AuthManager.LoginAsAnonymous(); } } private void OnApplicationQuit() { PlayerPrefs.SetString("StoredSession", JsonUtility.ToJson(AuthManager.UserSession)); } ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/user-management#log-in-to-a-ready-player-me-account) Log in to a Ready Player Me account This method sends a verification code to the provided email address, as shown below. This method accepts the verification code received via email and an optional `userId` parameter to merge the current anonymous account with the Ready Player Me account. By default, the parameter is set to `null`, indicating no account merging. **Example** The following method demonstrates how to log in a user and merge their previous anonymous account. circle-info Sessions for both anonymous and Ready Player Me accounts are stored in the `userSession` variable similarly. So, if you want to save the session for the user with a logged-in Ready Player Me account, use the same process as in the example above. [PreviousLogout Elementchevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements/logout-element) [NextLoad 2D Renderschevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/load-2d-renders) Last updated 1 year ago Was this helpful? * [Creating and logging in of anonymous users](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/user-management#creating-and-logging-in-of-anonymous-users) * [Log in to a Ready Player Me account](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/user-management#log-in-to-a-ready-player-me-account) Was this helpful? sun-brightdesktopmoon Copy public static async void SendEmailCode(string email) Copy public static async Task LoginWithCode(string otp, string userIdToMerge = null) Copy public void Login(string code) { AuthManager.LoginWithCode(code, AuthManager.UserSession.Id); } sun-brightdesktopmoon --- # Avatar Creator for WebGL | Ready Player Me Players can create Ready Player Me avatars seamlessly within a Unity WebGL application. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-webgl#prerequisites) Prerequisites **Ready Player Me SDK.** You need the Ready Player Me SDK for Unity installed with your project to retrieve avatars. See the [**Quickstart guide**](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/quickstart) for download and setup instructions. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-webgl#ready-player-me-webgl-sample) Ready Player Me WebGL Sample To run the WebGL Sample you will need to do as follows: 1. Open the Unity Package manager by going to `Window/Package Manager` 2. Find and select the Ready Player Me Core package 3. On the right side of the window open the Samples section 4. Find the `WebGLSample` and the click Import button 5. After it imports you should get a popup asking if you want to auto import the `WebGLTemplate`, we recommend you click OK 6. After all that is complete you should see the WebGL sample is imported and can be found in the `Assets/Samples/Ready Player Me Core/VERSION_NUMBER/WebGLSample` folder 7. In there you will find a Scenes folder with the example scene 8. You can add this into your build settings if you want to test it out. As this uses a WebGL template to display the iFrame it will not work in Editor 9. Lastly if you have set everything up correctly you can build and run for WebGL to run the WebGLSample scene circle-exclamation If you had errors importing or you did not receive the auto import popup you can manually import the `RpmWebGLTemplate` by importing the Unity package which can be found in the project hierarchy under `Packages/Ready Player Me Core/Editor/WebView/RpmWebGLTemplate.unitypackage`. You may also need to manually adjust the WebGL Player settings to use the WebGLTemplate named `RPMTemplate` [PreviousAvatar Creator for Android & iOSchevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-android-and-ios) [NextBuild your own Avatar Creatorchevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator) Last updated 1 year ago Was this helpful? * [Prerequisites](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-webgl#prerequisites) * [Ready Player Me WebGL Sample](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-webgl#ready-player-me-webgl-sample) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Avatar Loader Window | Ready Player Me ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FSXIm1XyRLozgskVbQon2%252Fimage.png%3Falt%3Dmedia%26token%3D2b4932f7-af41-49d7-ba93-9c620db0d152&width=768&dpr=4&quality=100&sign=7028bfba&sv=2) The Ready Player Me SDK allows you to preload an avatar from a specific URL, this is useful when you want to download and set up a default avatar or test avatars in the editor. For loading your avatar in-game, refer to the [Loading 3D Avatars](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/code-samples/loading-3d-avatars) section. To open the avatar loader, go to `Tools > Ready Player Me` and select **Avatar Loader** in the menu. ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FsPhgHXHRRAFN8PgdQHRK%252Fimage.png%3Falt%3Dmedia%26token%3D52c26d6e-9440-46ba-b017-f26867b72cd2&width=768&dpr=4&quality=100&sign=1ebf997&sv=2) This will open the loader interface, which includes three fields: * **Avatar URL**: The URL of the avatar you want to load into the scene. * **Use Eye Animations**: Adds the `EyeAnimationHandler` script to the downloaded avatar, enabling eye-blinking animations. Ensure that the `eyeBlinkLeft` and `eyeBlinkRight` morph targets are added in the avatar's configuration settings for this to work correctly. * **Use Voice To Audio**: Adds the `VoiceHandler` script to the avatar, which animates the mouth based on input from your primary microphone or an audio clip. Ensure that the `mouthOpen` morph target is added to the avatar configuration for this to work correctly. [PreviousLoad 2D Renderschevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/load-2d-renders) [NextSetup Multiplayerchevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer) Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Build your own Avatar Creator | Ready Player Me The Ready Player Me Unity SDK provides all the functionality you need to build your own Avatar Creator within Unity. You can use all the assets as well as the backend of Ready Player Me. We provide a ready-to-use example to help you get started. ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252FwArRbL7Sy5oO4vRV9bgb%252FCleanShot%25202024-02-06%2520at%252015.38.14.gif%3Falt%3Dmedia%26token%3Db47407f4-b1e0-4dc4-b52c-956848ca206a&width=768&dpr=4&quality=100&sign=94ae23e&sv=2) Custom Sci-Fi Avatar Creator UI made with Unity ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#supported-platforms) Supported Platforms * Windows/Mac/Linux Standalone * WebGL * Android (also mobile VR) * iOS ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#prerequisites) Prerequisites * [Ready Player Me Unity SDK Core 6.0.0+arrow-up-right](https://github.com/readyplayerme/rpm-unity-sdk-core) installed. See [Quickstart](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/quickstart) for instructions. * The Avatar Creator requires a subdomain and an AppID. Login to [https://studio.readyplayer.mearrow-up-right](https://studio.readyplayer.me/applications) to obtain a subdomain and AppID. See also [Studio (Developer Dashboard)](https://docs.readyplayer.me/ready-player-me/customizing-guides/studio-developer-dashboard) . * In your Unity project, select `Tools > Ready Player Me > Settings` to set you AppID. triangle-exclamation The AppID must belong to the subdomain you set; otherwise, authorization will fail. [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#build-your-avatar-creator) Build your Avatar Creator ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To build your Avatar Creator, you can * customize and extend the provided sample objects and code, or * start from scratch and use Ready Player Me Avatar Creator elements to build your own Avatar Creator. In either case, we strongly recommend that you start by working with the sample Scene and provided explanations to become familiar with the customizable elements that make up any Ready Player Me Avatar Creator. You can then use the [Elements](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements) and [User Management](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/user-management) reference pages to add and customize functionality, or start from scratch. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#limitations) Limitations * Camera support is currently only available for PCs using Unity's webcam native API. * Unity does not have a native file picker, so we have discontinued support for this feature. To add support for a camera or a file picker on another platform, you must implement it yourself. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#get-building) Get building... [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/quickstart) **Start with the sample** Explore the sample in the SDK and learn about the Avatar Creator structure, elements, and scripts. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/elements) **Avatar Creator Elements** Use and customize Avatar Creator elements (building blocks) to integrate with your own UI and user experience. [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/user-management) **User Management** Learn how to authenticate and manage your Ready Player Me users. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#undefined) [PreviousAvatar Creator for WebGLchevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/webview-avatar-creator/avatar-creator-for-webgl) [NextStart with the samplechevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator/quickstart) Last updated 1 year ago Was this helpful? * [Supported Platforms](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#supported-platforms) * [Prerequisites](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#prerequisites) * [Build your Avatar Creator](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#build-your-avatar-creator) * [Limitations](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#limitations) * [Get building...](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#get-building) * [](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/build-your-own-avatar-creator#undefined) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Setup Multiplayer | Ready Player Me Ready Player Me is designed for your multiplayer games. Learn how to set up Ready Player Me for Photon or Unity Netcode. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer#setup-the-player-character) Setup the Player Character The player avatar can have multiple components for custom functionality. For a multiplayer game or app, you don't want to instantiate the game object, and/or all components every time the player loads or changes its appearance. #### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer#use-the-template-avatar-as-your-default-character) Use the template avatar as your default character After installing the Ready Player Me Unity SDK Core, you find a template avatar with all possible mesh combinations in the Resources folder. Use it to set up your player avatar and attach all functionality to it. Both template avatar prefabs will have a NetworkPlayer script attached to them which handles loading the avatars. ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252F9Tf3yqeWWII33t5WVldH%252Fimage.png%3Falt%3Dmedia%26token%3Dc7cefb0d-d24c-454c-9bfe-b1684fd3454c&width=768&dpr=4&quality=100&sign=8fc64a65&sv=2) Ready Player Me avatar template with multi-mesh support. #### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer#load-the-users-avatar-and-exchange-the-mesh) Load the User's Avatar and exchange the mesh After loading the User-Avatar, you'll be returned a GameObject from the `AvatarManager`. Do not use this game object, instead do a mesh transfer and destroy the game object. You can use the `AvatarMeshHelper.TransferMesh(...)` from the SDK. Check out how it's done in the packages for both, Photon and Unity Netcode below. ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer#add-photon-support) Add Photon Support Photon requires characters to be preconfigured prefabs to be instantiated when a player joins a room, and RPM avatars are used by loading them at runtime. [This packagearrow-up-right](https://github.com/readyplayerme/rpm-unity-sdk-photon-support) helps solve this problem by providing an avatar prefab and a component that handles avatar loading by transferring the avatar mesh and material to a character prefab. When working with Photon PUN, you can instantiate your modified version of `RPM_Photon_Character` prefab in overridden `OnJoinedRoom` method of your class that inherits `MonoBehaviourPunCallbacks`. Once the prefab is instantiated, you can get the `NetworkPlayer` component of this GameObject and call its `LoadAvatar` method with the URL of the avatar you want to load. This will load the avatar in all the clients using a photon RPC method and synchronize the characters. You can check the Avatar Control sample from the package to see the working example. Learn more about the Requirements and installation on GitHub: [https://github.com/readyplayerme/rpm-unity-sdk-photon-supportarrow-up-right](https://github.com/readyplayerme/rpm-unity-sdk-photon-support) ### [hashtag](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer#add-unity-netcode-support) Add Unity Netcode Support [This packagearrow-up-right](https://github.com/readyplayerme/rpm-unity-sdk-netcode-support) supports loading Ready Player Avatars in a multiplayer application using [Netcodearrow-up-right](https://unity.com/products/netcode) . This can be used as a reference for anyone wanting to use Ready Player Me Unity SDK to create a multiplayer using Unity Netcode. When working with Unity Netcode for GameObjects, you can set this prefab as the Network prefab of your Netcode project and when a user or host joins set `NetworkPlayer` scripts static `InputUrl` field to the URL of the avatar the user wants to use. When the game starts players will be loaded by NetworkPlayer script using their own avatars. You can check the Avatar Control sample from the package to see the working example. Learn more about the Requirements and installation on GitHub: [https://github.com/readyplayerme/rpm-unity-sdk-netcode-supportarrow-up-right](https://github.com/readyplayerme/rpm-unity-sdk-netcode-support) [PreviousAvatar Loader Windowchevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-loader-window) [NextSetup for XR (Beta)chevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-for-xr-beta) Last updated 1 year ago Was this helpful? * [Setup the Player Character](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer#setup-the-player-character) * [Add Photon Support](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer#add-photon-support) * [Add Unity Netcode Support](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-multiplayer#add-unity-netcode-support) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Ready Player Me Animation Library | Ready Player Me Ready Player Me full-body avatars are compatible with our game-ready animation library. ![](https://docs.readyplayer.me/ready-player-me/~gitbook/image?url=https%3A%2F%2F3222463673-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FM2pnrVNxW01XV9ilR0Ed%252Fuploads%252Ftqr5XzK8i7ryWeuiPufa%252Fanimationpack.gif%3Falt%3Dmedia%26token%3D30af42be-9fdf-4040-b067-4358e589aeb1&width=768&dpr=4&quality=100&sign=7d5837d&sv=2) It contains the initial batch of 200+ high-quality motion-captured animations retargeted to Ready Player Me character armatures. We provide these animations free for you to use in your projects as per the license found [herearrow-up-right](https://github.com/readyplayerme/animation-library/blob/master/LICENSE) . [Check out the Package on GitHubarrow-up-right](https://github.com/readyplayerme/animation-library/tree/master) [Learn how to use the animations from the animation library in Unityarrow-up-right](https://github.com/readyplayerme/animation-library/blob/master/guides/Unity-Guide.md) [PreviousAnimationschevron-left](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/animations) [NextMixamo Animationschevron-right](https://docs.readyplayer.me/ready-player-me/integration-guides/unity/animations/loading-mixamo-animations) Last updated 1 year ago Was this helpful? Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon --- # Email Protection | Cloudflare Please enable cookies. Email Protection ================ You are unable to access this email address docs.readyplayer.me --------------------------------------------------------------- The website from which you got to this page is protected by Cloudflare. Email addresses on that page have been hidden in order to keep them from being accessed by malicious bots. **You must enable Javascript in your browser in order to decode the e-mail address**. If you have a website and are interested in protecting it in a similar way, you can [sign up for Cloudflare](https://www.cloudflare.com/sign-up?utm_source=email_protection) . * [How does Cloudflare protect email addresses on website from spammers?](https://developers.cloudflare.com/waf/tools/scrape-shield/email-address-obfuscation/) * [Can I sign up for Cloudflare?](https://developers.cloudflare.com/fundamentals/setup/account/create-account/) Cloudflare Ray ID: **9bf3d6a30eda7ad2** • Your IP: Click to reveal 54.237.218.47 • Performance & security by [Cloudflare](https://www.cloudflare.com/5xx-error-landing) --- # Changelog | Ready Player Me ### [hashtag](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2023-07-07) 2023-07-07 * Update authentication endpoint ### [hashtag](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2023-06-28) 2023-06-28 * Introduced new endpoint [Create Guest User](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/users/post-create-user) * Introduced new endpoint [Create Short Lived Token](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/auth/get-token) ### [hashtag](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2023-05-10) 2023-05-10 * Public launch of [Assets Endpoints](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/assets) ### [hashtag](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2023-02-08) 2023-02-08 * Changed the default base URL for 3D Avatars, 2D Avatars and Avatar Metadata from `api.readyplayer.me` to `models.readyplayer.me` for internal performance reasons. ### [hashtag](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2022-12-12) 2022-12-12 * New parameter `quality` with three quality presets (low, medium, high). * New parameter `textureChannels` to choose the included texture channels. * Parameter `meshLod=1` now has now a 50% reduction in poly-count (was at 25% before). * Parameter `meshLod=2` now has now a 75% reduction in poly-count (was at 50% before). * All parts of the avatar other than glasses are now affected by the `meshLod` parameter. Previously it was only the outfit. ### [hashtag](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2022-09-28) 2022-09-28 * Parameter `meshLod=2` now has now a 75% reduction in poly-count (was at 50% before). * Parameter `meshLod=1` now has now a 50% reduction in poly-count (was at 25% before). * Parameter `meshLod=2` now has now a 75% reduction in poly-count (was at 50% before). * All parts of the avatar other than glasses are now affected by the `meshLod` parameter. Previously it was only the outfit. Initial public launch of Avatar API - 3D Avatars with seven parameters. * All parts of the avatar other than glasses are now affected by the `meshLod` parameter. Previously it was only the outfit. * `morphTargets` to choose the included blend shapes. * `textureSizeLimit` to specify the maximum texture size. * `meshLod` to request different level of details. * `useDracoCompression` to enable server-side compression. * `textureAtlas` to specify the atlas size. * `pose` to request an avatar with default pose of A or T. * `useHands` to request a half-body avatar with or without hands. Initial public launch of Avatar API - 2D Avatars with 2 parameters. * `scene` to specify the portrait-type to render. * `blendShapes` to specify blendShape values. Initial public launch of Avatar API - Metadata. Last updated 5 months ago Was this helpful? * [2023-07-07](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2023-07-07) * [2023-06-28](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2023-06-28) * [2023-05-10](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2023-05-10) * [2023-02-08](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2023-02-08) * [2022-12-12](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2022-12-12) * [2022-09-28](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/changelog#id-2022-09-28) Was this helpful? sun-brightdesktopmoon sun-brightdesktopmoon ---