Ask or search…
⌃K
Links

Quickstart

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

Before you begin

  • This quickstart tutorial assumes you are working on a mac, as this is required to run and build iOS apps.
  • Download and install Xcode to your mac.

1. Pull down the example repo

Go to the Ready Player Me GitHub organization and pull down the iOS swift example project to your local machine. You can find this example repository here: https://github.com/readyplayerme/Example-iOS-Swift​

2. Open the example repo with Xcode and run it

Open the project in Xcode and run it using the play button as shown below.
Upon doing the above, your project should start in the iOS emulator, and you will have a working example of an iOS app using the avatar creator web view.
​

3. Use your subdomain in your project

Now that the project is working locally for you, you can ensure that the avatars created in the project will be associated to your Ready Player Me application by including your subdomain in the project. First, sign in (or sign up) to Studio (Developer Dashboard), navigate to 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 iOS project and then navigate to the AvatarCreatorSettings Swift file to replace the 'demo' value with your subdomain.

4. Make your project awesome!

You now have a working native iOS 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.