LogoLogo
WebsiteBlogForumsSign up
  • Welcome
  • How Ready Player Me works
  • FAQ
  • 👩‍💻Integration Guides
    • Overview
    • Unity
      • Quickstart
      • Avatar Creator Integration
        • WebView Avatar Creator
          • Avatar Creator for Android & iOS
          • Avatar Creator for WebGL
        • Build your own Avatar Creator
          • Start with the sample
          • Elements
            • Asset Selection Element
            • Color Selection Element
            • Template Selection Element
            • Body Shapes Selection Element
            • Gender Selection Element
            • Avatar List Element
            • Photo Capture Element
            • Signup Element
            • Login Element
            • Logout Element
          • User Management
      • Load 2D Renders
      • Avatar Loader Window
      • Setup Multiplayer
      • Setup for XR (Beta)
        • Setup the Player Avatar
        • Setup Meta Movement SDK
        • Setup Final IK
        • Setup XR Hands
          • RpmHandDriver script
        • Facial Animations
        • VR Avatar Creator
      • Animations
        • Ready Player Me Animation Library
        • Mixamo Animations
      • Optimize
        • Avatar Configuration
        • Avatar Caching
        • Defer Agents
      • Code Samples
        • Loading 3D Avatars
        • Loading 2D Avatars
        • Avatar Creator (WebGL)
        • Avatar Creator (Desktop)
        • Avatar Creator (Mobile)
        • Distance-based LODs
      • Troubleshooting
        • Editor UI Window Issues
        • Avatar loading issues
        • iOS issues
        • WebGL issues
        • Firewall issues
        • Updating the SDK
          • Unity SDK 3.0.0 Migration guide
          • Unity SDK 4.0.0 Migration guide
          • Unity SDK 5.0.0
          • Unity SDK 7.0.0
          • WebView 2.0 Migration
        • Package installation issues
      • Help us improve the Unity SDK
      • FAQ for Unity
      • Early Access Features
    • Unreal Engine
      • Quickstart
        • Import SDK Manually
      • Avatar Creator Integration
        • Build your own Avatar Creator
          • Sample Structure
          • Customization Guide
        • WebView Avatar Creator
      • Load Avatars
      • Animations
        • Ready Player Me Animation Library
        • Loading Mixamo animations
        • Mannequin animation retargeting
        • Blender FBX export to UE
        • Oculus Lipsync integration
      • Optimize
        • Avatar configuration
        • Avatar caching
        • Avatar preloading
      • Code Samples
        • Unreal Engine 5 samples
        • Lyra project integration example
        • VR Avatars
        • Unreal Engine 4
      • Troubleshooting
        • Project compilation issues
        • Missing materials on built applications
        • Avatar loading issues
        • Animation issues
        • Unreal SDK breaking changes
        • Avatar lighting issues
        • Updating from earlier versions
          • Unreal SDK 3.0.0 Migration guide
        • Auto LOD issues
      • Help us improve the Unreal Engine SDK
      • FAQ for Unreal Engine
      • Early Access Features
    • React
      • Quickstart
    • React Native
    • iOS Native
    • Android Native
    • Web Integration
      • Quickstart
      • User Management
        • Guest Accounts
        • Account Linking
      • Avatar Creator integration
      • Optimize
    • API Integration
      • Quickstart
      • Custom Avatar Creator
      • User management
        • Ready Player Me Account
        • Anonymous Accounts
    • UX/UI Guidelines
      • Summary & quick tips
      • UX and UI guidelines and essentials
        • Foundation for good user experience
          • Layout
          • Colors
          • Typography
          • Icons
          • Dark mode and light mode
        • Mobile best practices
          • Layout
        • Making Ready Player Me feel native
          • Seamless Avatar Integration
          • Consistent Branding
          • Responsive Layout
          • Performance Optimization
        • Discoverability of the avatar editor
          • Onboarding tutorial
          • Clear navigation
          • Contextual Placement
  • 🖌️Customizing Guides
    • Studio (Developer Dashboard)
    • Avatar Creator Appearance
      • Avatar URLs
      • Avatar Shortcodes
    • Upload and Manage Custom Assets
      • Asset Manager in Studio
      • Configure in Studio
      • Manage custom assets using the API
      • Unlocking assets through API (Beta)
    • Create Custom Assets
      • Fullbody Outfits
        • Checking Skin Weights
      • Tops, Bottoms, Shoes
        • Editing templates
      • Hairstyle
      • Headwear
      • Facewear
      • Glasses
      • Hero Characters
      • Modeling Guidelines
  • 🔃API Reference
    • REST API
      • Authentication
      • Avatars
        • GET - 3D avatar
        • GET - 2D Render of an Avatar
        • GET - Metadata
        • PUT - Equip an asset
        • PUT - Unequip an asset
      • Assets
        • Asset Entity Properties
        • POST - Create Asset
        • GET - List Assets
        • PATCH - Update Asset
        • POST - Upload Asset Files
        • POST - Add Asset to Application
        • DELETE - Remove Asset from Application
        • PUT - Unlock asset for a user
        • PUT - Lock asset for a user
      • Users
        • POST - Create User
      • Auth
        • GET - Token
      • Changelog
    • Avatars
      • Full-body avatars
      • Full-body XR avatars
      • Half-body avatars
      • Morph targets
        • Apple ARKit
        • Oculus OVR LipSync
    • Avatar Creator
  • 🔉Support
    • Forums
    • Licensing & Privacy
Powered by GitBook
On this page
  • Install and run the sample
  • Under the hood
  • The SimpleAvatarCreator script
  • Elements for selecting assets and colors
  • User management
  • Next steps

Was this helpful?

  1. Integration Guides
  2. Unity
  3. Avatar Creator Integration
  4. Build your own Avatar Creator

Start with the sample

Avatar Creator sample Scene that showcases elements, scripts, and customization.

PreviousBuild your own Avatar CreatorNextElements

Last updated 11 months ago

Was this helpful?

In this guide, you will explore and modify a sample Ready Player Me Avatar Creator to learn about required and optional elements and scripts, and how to customize them.

AvatarCreatorElements is an example Scene featuring core elements that are essential for setting up a Ready Player Me Avatar Creator within a game or application.

Install and run the sample

  1. Start a Unity project and verify that it meets the .

  2. Open Window -> Package Manager.

  3. Find the Ready Player Me Core package.

  4. Click the Samples tab, then scroll to AvatarCreaterSamples and click Import.

  1. Open the AvatarCreatorElements Scene located in Assets/Samples/Ready Player Me Core/VERSION_NUMBER/AvatarCreatorSamples/AvatarCreatorElements/Scenes.

  2. Press Play and explore the functionality of this minimalist Avatar Creator. (If your Scene looks clipped, make sure the Scale is set to 1 and you use a fixed aspect ratio, such as 16:9.)

Under the hood

Guided by the tips below, familiarize yourself with the elements that make up this example Avatar Creator.

Every Ready Player Me Avatar Creator must include the following elements and scripts in order to work.

  • An AvatarCreator GameObject with a script (SimpleAvatarCreator in this sample) that runs the show, as described below.

  • Elements where users can choose their avatar assets (AvaterCreatorUI > Elements in the sample). Each element includes a script that lists customizable UI elements.

  • Elements for user management (collected in the AvatarCreaterUI > UserManagement GameObject in the sample), including saving avatars and logging in to Ready Player Me accounts.

  • Buttons for login, saving, and creating new avatars (collected under the AvatarCreatorUI > Buttons GameObject in the sample).

  • Optional Buttons (also collected under the AvatarCreatorUI > Buttons GameObject in the sample) that allow users to switch between asset elements, for example, if your UI cannot accommodate showing all elements at the same time.

  • The TemplateSelectionElement, which lets users pick an appearance when they start designing a new avatar.

The SimpleAvatarCreator script

The sample Scene uses a single script SimpleAvatarCreator(you can find it in Assets > Samples > Ready Player Me Core > VERSION > AvatarCreatorSamples > AvatarCreatorElements > Scripts) attached to the AvatarCreator GameObject to seamlessly connect all the asset selection elements as well as manage user sessions and avatars.

The SimpleAvatarCreator script in turn uses the Ready Player Me Core package's AvatarManager script (Packages > Ready Player Me Core > Runtime > AvatarCreator > Scripts > Managers) to load, update, and create new avatars for users.

Public variables of the SimpleAvatarCreator script

  • On Avatar Created: An event triggered whenever an avatar is created or updated. In the sample, this triggers display of the TemplateSelectionElement.

  • Asset Selection Elements: A list of AssetSelectionElement objects. Each element displays assets of a certain type for the user to choose. Asset selection elements initialize upon the application's first run. The script listens for changes (e.g., selecting outfits) and updates the avatar accordingly.

  • Color Selection Elements: A list of color selection elements for setting asset or body color. Each ColorSelection item represents one color. Similar to the asset selection elements, color selection elements initialize upon the application's first run, the script listens for changes, and updates the avatar accordingly.

  • Animation Controller: Attached to the displayed avatar to control its animations. In this sample, the animator allows the user to rotate the avatar using mouse controls.

  • Loading Overlay: A simple overlay message indicating a loading state.

  • Create RPM Account: A GameObject referencing a Prefab for creating a Ready Player Me account. This is displayed if a user saves the avatar but is not logged in.

Elements for selecting assets and colors

You can find the Prefabs for these core elements inReady Packages/Ready Player Me Core/Runtime/AvatarCreator/Prefabs/Elements.

User management

Because Ready Player Me is a free product, and we like to keep it that way, we ask you to always include the Ready Player Me Login and SignUp elements.

Next steps

Customize and expand the Avatar Creator Elements sample for your own application, or start from scratch to create your own Ready Player Me Avatar Creator.

An asset selection element displays all assets of an asset type and manages the callback for a selection. Similarly, a color selection element lets your users choose a color for an asset category, such as eyes or hairstyle, or the avatar's skin tone. (You choose which assets to include in the .)

See for details on these and additional elements, and on how to customize them.

The sample's UI includes buttons for creating a new avatar, saving an avatar, getting a list of avatars, and login into a Ready Player Me account (, , ).

When a user opens the sample Avatar Creator for the first time, they are assigned an . This allows them to use the Ready Player Me ecosystem without having a registered account.

The sample does not include session management for the user. If you would like to save and store user sessions in your application, see .

See the reference for details on all available Avatar Creator elements.

See for guidance on handling sessions and Ready Player Me user accounts.

👩‍💻
Asset Manager in Studio
Elements
SignUp Element
Login Element
Logout Element
anonymous Ready Player Me account
User Management
Elements
User Management
Prerequisites
Import Avatar Creator Sample from the Package Manager