Web - Ready Player Me

To use Ready Player Me in your commercial app or game, you need to register as a Partner. This will allow you to have your own partner subdomain (i.e. yourappname.readyplayer.me).
​Learn more about becoming a Partner or sign up here.
If you want to test the integration, you can use the demo.readyplayer.me domain. Please note that it’s now allowed to use it for public projects.
<iframe> integration
Ready Player Me can be embedded into your existing web application as an iframe.
Integration is as easy as
1.Update our iframe example with https://yourappname.readyplayer.me
2.Embed the iframe onto your existing web frontend
A) Use the recommended iframe sizes 
B) or follow our iframe example which loads iframe in full screen
3.Retrieve avatar URLs with an eventListener
4.Close the iframe
Please find a complete example demonstrating the steps above in our GitHub https://github.com/readyplayerme/Example-iframe​
When an avatar is exported (the user has clicked the "Done" button), a URL to the avatar asset is created and made available to the parent of the iframe. The URL to the avatar asset can be automatically captured with an eventListener, for example:
1
window.addEventListener("message", receiveMessage, false);
Copied!
Please find a complete iframe working example here
​https://github.com/readyplayerme/Example-iframe​
​
Recommended iframe size
Ready Player Me works well at various screen sizes and resolutions. In case you're not embedding Ready Player Me as a full-screen iframe, here are recommended iframe resolutions you can use:
Desktop 1280 x 800px
Mobile 720 x 1080px
You can set these via the iframe width and height properties.
​
This allows for seamless integration of Ready Player Me into your application where users are kept in the flow of your app.
This also works great for (VR) apps with a user-facing web-based administrative dashboard. Embed Ready Player Me into it and associate the returned avatar URLs with your user accounts.
In addition, you can use our Unity SDK to import the avatars runtime into your application.
When a user customises and re-exports their avatar, the updated avatar is made available on the same URL as was created previously.

Integration Guides - Previous

Getting started

Next - Integration Guides

Unity SDK

Last modified 12d ago

Copy link

Contents