/rpm-unity-sdk-avatar-creator

Avatar Creator helps you create an avatar in Unity.

Primary LanguageC#MIT LicenseMIT

Ready Player Me Unity SDK Avatar Creator

GitHub release (latest SemVer) GitHub Discussions

image

Ready Player Me Avatar Creator is an extension to 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

:octocat: GitHub Discussions

Requirements

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 the production until the stable version is released.
  • AvatarCreator requires the App Id property to be set. Make sure that you set the AppId of your application in the Ready Player Me > Settings > App Id. You can find the AppId 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 demonstrate 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 currently only available for PC 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 camera on other platforms and file picker, you will need to implement it yourself.