Ready Player Me Unity SDK Avatar Creator DEPRECATED

This repository has been deprecated as it has been merged into: Ready Player Me Core.

Please note that this repository is no longer actively maintained or supported. We recommend that you update to Ready Player Me Core 4.0 or later.

For historical purposes, the code and documentation will remain available in this repository.

Ready Player Me Avatar Creator is an extension to the www.readyplayer.me avatar platform, which helps you create avatars natively.

Please visit the online documentation and join our public discord community.

Online Documentation

Discord Channel

GitHub Discussions

Requirements

• Unity Version 2020.3 or higher
• Git needs to be installed to fetch the Unity package. Download here
• Ready Player Me Core - v3.2.0+
• glTFast - v5.0.0

Supported Platforms

• Windows/Mac/Linux Standalone
• Android*
• iOS*

Quick Start

The installation steps can be found here.

Important

• The plugin is currently in beta stage. We recommend not to use it in production until the stable version is released.
• AvatarCreator requires the App Id property to be set. Make sure that you set the App Id of your application in the Ready Player Me > Settings > App Id. You can find the App Id of your application in the Studio.
• Important! AppID must belong to the subdomain you set otherwise authorization will fail. Login to studio.readyplayer.me to check your subdomain and AppID.

Features

• Avatar creation through image.
• API for fetching the default avatars.
• API for login with email and a verification code.
• API for fetching the user avatars.
• API for color selection.
• UI for the new APIs in the sample.

Structure

• The package contains APIs required for creating, customizing and loading the avatar.
• It also contains a sample which demonstrates the usage of the APIs and replicates RPM web avatar creator.
• The documentation of provided sample can be found here.

Customization

The documentation for customization can be found here.

Note

• [*]Camera support is only provided for Windows and WebGL, using Unity’s webcam native API.
• Unity does not have a native file picker, so we have discontinued support for this feature.
• To add support for file picker (for selfies) you have to implement it yourself