Getting started
You can use Ready Player Me to add avatars to your game or application. This general integration guide gives an overview of the main methods of adding avatars to your app.

Create avatars directly in Unity (Android + iOS)

This integration method lets users create Ready Player Me avatars directly in a WebView displayed within a Unity application.
This is achieved by displaying avatar creation and customization in a seamless interface allowing you to embed Ready Player Me avatar creation inside your Unity app.
The integration is similar to the <iframe> integration, with the main difference being a WebView used in Unity instead of an <iframe> on the web.
See the Unity integration guide for more details.
Unity WebView plugin is currently available for use with Android and iOS.
Example of Unity WebView on Android
Example of Unity WebView on iOS

Integrate into a web app

If your application lives on the web or has a user-facing web portal, you can integrate Ready Player Me as an <iframe> into your existing web frontend. When avatars are created, unique links to avatar 3D models are provided, which can be either imported to your web app straight away or stored for your user profile and be later imported into a Unity or Unreal app.
For example, if you were building a virtual meeting application that lives entirely on the web, here's how the integration could look like:
Open iframe, get avatar URL and import to your web app.

Access avatars via shortcodes

It is possible to bridge avatar creation and later retrieval via avatar shortcodes. When this feature is enabled for your partner subdomain, an avatar code is presented to the user after creating an avatar. Using our Unity SDK, this shortcode can be used to retrieve the avatar in your application.
This is especially useful for VR and mixed reality applications where avatar creation via WebView is difficult.
Here's how such integration type can be used:
In case you're attempting to use shortcodes without our SDK, for instance when using a custom game engine, you can retrieve avatars from shortcodes by using the following URL pattern:
for example

Integrate into a Unity or Unreal app

In case you have a web portal, but the avatars would be used inside a Unity or Unreal application, you'd likely first want to store the links to the avatar 3D models and later retrieve the avatars in your application. We provide SDKs for Unity and Unreal Engine with the primary purpose to import the avatar's runtime into your application. The heavy lifting of avatar creation and customization is handled on the web.
Here's how such integration typically looks like:
Create avatars on the web and retrieve them in-engine.