Ask or search…
⌃K
Links

Quickstart

Load a Ready Player Me avatar in your Android app in less than 5 minutes.

Before you begin

  • This quickstart tutorial assumes you have installed an Android Studio.

1. Pull down the example repo

Go to the Ready Player Me GitHub organization and pull down the Android example project to your local machine. You can find this example repository here:

2. Open the example repo with Android Studio and run it

Open up the Android Studio and run it.
This should boot up the Android device, if it was not already running, and open up the Ready Player Me example on the device.
Sometimes avatar models may appear invisible when testing with the emulator.
If you finished the flow of creating the avatar, the 2D image is rendered on the avatar page. The default link will load the avatar with default settings. You can also update the URL based on the parameters defined under 2D Render API to have a more specific 2D image of the avatar.

3. Use your subdomain in your project

Now that the project is working locally, you can ensure that the avatars created in the project will be associated with your Ready Player Me application by including your subdomain in the project. First, sign in (or sign up) to Studio (Developer Dashboard), navigate to the details page of the application you want to use, and then copy the subdomain value at the top of the page. Once you have your subdomain, go back to your project and then navigate to the UrlBuilder.kt file and replace the 'demo' value with your subdomain.
Now if you launch the project, the web view will successfully connect to your Ready Player Me application.

4. Make your project awesome!

You now have a working native Android app with a working implementation of the Ready Player Me avatar creator that will create avatars linked to your Ready Player Me application. At this point you can go in any direction you think makes sense for your project:
  • You can explore our web avatar creator docs more here, to find out more about how you can get data in and out of the creator.
  • You can learn how to customize the web avatar creator to match your branding here.
  • If you want something really custom, you can even explore our REST APIs and build a completely custom avatar creator without using our web creator at all.