Links

Avatar Creator Setup

Configure and customize the Avatar Creator. Register your app, create a subdomain, and manage your settings.
The Avatar Creator is a web-based, device-agnostic, and ready-to-use way of integrating the avatar creation and editing process into your game.
Avatar creation with the ready-to-use Avatar Creator.
You can fully integrate the Avatar Creator into your game.

1. Set up your app's Avatar Creator

​Sign in to Studio (Developer Dashboard) to customize your Avatar Creator. If you have no account yet, you can create one for free.
After you sign-up / sign in, you will see your first application already set up.
​
​
Once created, your subdomain is public, and users will immediately see any changes you make.

2. Configure your Avatar Creator

After you click on the app, you can modify and customize your Avatar Creator with the settings below.

Body type

Let users choose or default to a body type.
In the demo Avatar Creator (https://demo.readyplayer.me), by default, the first step for the user is to choose between a full-body and half-body avatar.
​
​
You can can change the default Body Type setting and define full-body or half-body as the default body type, and not give the user the freedom to choose. Click Save to apply your changes.
​
​

Language picker

Let users choose, or default to the system/browser language.
By default, users will see a language picker as shown below on the Avatar Creator.
​
​
You can enable or disable the language picker, and the Avatar Creator will default to the user's chosen system/browser language. Click Save to apply the changes.
​
​

Avatar creation success window

After successful avatar creation, the popup shown below displays the avatar URL to the user. With this URL, users can download the GLB file for their avatar.
​
​
Disable the Download the avatar popup to prevent users from accessing their avatars via URL. Click Save to apply your change.
​
​

Avatar shortcode

After successful avatar creation, you can opt to display the avatar shortcode above the avatar URL. Users receive a 6-digit code they can use in your application to load the avatar. This is especially useful for VR and mixed reality applications because avatar creation via WebView can be difficult.
​
​
Turn on the Avatar Shortcode setting to show users the avatar shortcode (Example: https://readyplayer.me/api/avatar/KJIXZB). Note that entering or clicking a shortcode in the browser will download the avatar GLB.
​
​

QR code to download avatar

After successful avatar creation, you can opt to display a QR code that represents a link to the avatar GLB. Scanning the code downloads the avatar.
​
​
Enable or disable this setting. Click Save to apply the changes.
​
​

Theme

Choose a light (default) or dark theme for the Avatar Creator to best match the user's overall experience with your app.
Comparison of light and dark theme for Avatar Creator.
Click the Theme tab and select the theme that matches your app or game. Click Save to apply the changes.
​
​

More Avatar Creator configurations

See the Avatar Creator API Reference on how to affect the following and other Avatar Creator settings via postMessage by URL.
​