Ready Player Me

https://docs.readyplayer.me/ready-player-me/
Admin
Ready Player Me is a cross-game avatar platform that enables developers to integrate customizable...
Tokens:531,909
Snippets:2,951
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Unity SDK Guides Overview

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unity

Outlines the available guides for the Ready Player Me Unity SDK, covering quickstart avatar loading, Avatar Creator integration, animations, and optimization techniques.

```Unity
1. Quickstart: Load your first personal avatar into Unity in under 10 minutes.
2. Avatar Creator: Integrate and customize the ready-to-use Avatar Creator.
3. Animations: Add animations and facial expressions to avatars.
4. Optimize: Optimize avatars based on available computing and graphics power.
```

--------------------------------

### Web Integration Quickstart

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-for-xr-beta/facial-animations

A quickstart guide for integrating Ready Player Me avatars into web applications. Covers user management, avatar creator integration, and optimization.

```Web Integration
Quickstart
User Management
Guest Accounts
Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Unreal Engine SDK Setup and Usage

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine/quickstart

This section details the process of setting up and using the Ready Player Me SDK within an Unreal Engine project. It covers installation from the Unreal Marketplace, enabling the plugin, configuring project-specific settings like subdomain and App ID, and running a quickstart map to visualize avatars. It also explains how to load a personal avatar into the scene and provides guidance on viewing plugin content.

```Unreal Engine
1. Get, download, and install the plugin to your engine
   - Unreal Marketplace: Search for "Ready Player Me Avatar and Character Creator".
   - Manual Installation: For versions not supported by the marketplace, follow manual installation instructions.

2. Setup plugin for your project
   - Open your Unreal Engine project.
   - Enable the "Ready Player Me" plugin via the Plugins menu.
   - Restart the Unreal Engine editor.

3. Enter your subdomain
   - Access the Setup Guide editor window upon first integration.
   - Enter your **subdomain** and **app ID** obtained from the Ready Player Me Studio (Developer Dashboard).
   - Alternatively, enter "demo" to sign up later.
   - Update settings via Project Settings if needed.

4. Help us improve the SDK
   - Enable/disable analytics to help improve SDKs.
   - Click "Finish Setup".

5. Integration guide
   - Utilize the integration guide for essential steps.
   - Click "Load Quickstart Map" to see Ready Player Me avatars in action.

6. Run the Quickstart Map
   - Open the QuickStart map.
   - Click "Play" to interact with the default avatar.

7. Load your personal avatar into the scene
   - Press the **Q** key to open the avatar creator window.
   - Create your avatar and click "Save".
   - The avatar will load after completion.

Viewing Plugin Content:
  - In the Content Browser, enable "Show Plugin Content" and "Show Engine Content" (Settings > View Options).
  - Navigate to Engine Plugins (or Plugins folder if installed manually) and find "ReadyPlayerMe Content" folders.
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration/quickstart

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration Quickstart

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unity/help-us-improve-the-unity-sdk

A quickstart guide for integrating Ready Player Me avatars into web applications. Covers user management, avatar creator integration, and optimization.

```Web Integration
Quickstart
User Management
Guest Accounts
Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Unreal Engine SDK Setup

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine

Instructions for setting up the Ready Player Me Unreal Engine SDK. Supports Unreal Engine 5 and 4.27 or higher. Includes options for Unreal Marketplace and manual GitHub installation.

```APIDOC
Unreal Engine SDK Installation:

Option 1: Unreal Marketplace
  - Download the SDK from the Unreal Marketplace.
  - Supports the three latest versions of Unreal Engine (5.2, 5.3, 5.4).

Option 2: Ready Player Me Unreal SDK GitHub Repository
  - Visit the GitHub page for the latest release.
  - Follow the steps for manual installation.
  - Compatible with Unreal Engine 5 and 4.27 or higher.
```

--------------------------------

### Web Integration Quickstart

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unity

A quickstart guide for integrating Ready Player Me avatars into web applications. Covers user management, avatar creator integration, and optimization.

```Web Integration
Quickstart
User Management
Guest Accounts
Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration Quickstart

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine/troubleshooting/unreal-plugin-download/unreal-sdk-3

A quickstart guide for integrating Ready Player Me avatars into web applications. Covers user management, avatar creator integration, and optimization.

```Web Integration
Quickstart
User Management
Guest Accounts
Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine/quickstart

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration Quickstart

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unity/troubleshooting/firewall-issues

A quickstart guide for integrating Ready Player Me avatars into web applications. Covers user management, avatar creator integration, and optimization.

```Web Integration
Quickstart
User Management
Guest Accounts
Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/ux-ui-guidelines/ux-and-ui-guidelines-and-essentials/discoverability-of-the-avatar-editor/onboarding-tutorial

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration Quickstart

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine/code-samples/vr-avatars

A quickstart guide for integrating Ready Player Me avatars into web applications. Covers user management, avatar creator integration, and optimization.

```Web Integration
Quickstart
User Management
Guest Accounts
Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/support

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration/user-management/guest-accounts

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/ux-ui-guidelines/summary-and-quick-tips

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration/optimize

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration/user-management/account-linking

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine/faq-for-unreal-engine

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration/user-management

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration/avatar-creator-integration

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/web-and-native-integration

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/ux-ui-guidelines/ux-and-ui-guidelines-and-essentials

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Fixing QuickStart Example in Unreal Engine

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine/troubleshooting/unreal-plugin-download/unreal-sdk-3

Instructions for resolving issues with the QuickStart example in Unreal Engine after moving it into the project. This section focuses on ensuring correct references and functionality.

```APIDOC
QuickStart Example Fixes:

Ensure the QuickStart example is correctly integrated into your project.
Specific steps may involve re-adding references or validating configurations.
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine/troubleshooting/unreal-plugin-download

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Install Expo CLI and Project Dependencies

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/react-native

Installs the Expo CLI globally and then installs project dependencies for a React Native project using Expo. It also starts the Expo development server.

```bash
npm install --global expo-cli
```

```bash
npm install
expo start
```

```bash
expo start --tunnel
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unreal-engine/quickstart/setup-c%2B%2B-projects

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-for-xr-beta/setup-meta-movement-sdk

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```

--------------------------------

### Android Native Quickstart Guide

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/quickstart-1

This guide explains how to set up and run the Ready Player Me example project for Android Native integration. It covers cloning the repository, opening it in Android Studio, and basic usage.

```English
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:
  * https://github.com/readyplayerme/Example-Android-Kotlin

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
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.
```

--------------------------------

### Web Integration and User Management

Source: https://docs.readyplayer.me/ready-player-me/integration-guides/unity/setup-for-xr-beta/setup-final-ik

Guides for integrating Ready Player Me avatars into web projects, including quickstart, user management with guest accounts and account linking, and avatar creator integration.

```Web Integration
Quickstart
User Management
  Guest Accounts
  Account Linking
Avatar Creator integration
Optimize
```
Tokens:
Raw