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
  • Avatar Configuration templates
  • Create an Avatar Configuration
  • Avatar Configuration Settings
  • Apply an Avatar Configuration
  • Editor Avatar Loader
  • Runtime Avatar Object Loader
  • Examples

Was this helpful?

  1. Integration Guides
  2. Unity
  3. Optimize

Avatar Configuration

Apply Avatar API parameters to avatar loading.

PreviousOptimizeNextAvatar Caching

Last updated 1 year ago

Was this helpful?

The Ready Player Me Avatar API allows partners to specify the Avatar Configuration parameters to apply when loading avatars. These configuration parameters can be applied in the Unity Editor Avatar Loader or at runtime.

The SDK provides functionality for loading avatars with specific configurations. For example, you may need a high-quality detailed avatar for showing the model at close range, and a low-quality avatar that will be rendered in a single draw call for other situations. You can set the configuration for each avatar with a custom Avatar Config data asset.

Avatar Configs will only work with the new avatar API URLs. If you have a saved URL in your project, you may need to regenerate the avatar and update the URL in order to use the Avatar Config.

Avatar Configuration templates

Several Avatar Configuration templates are included in the SDK with recommended settings for high, medium, and low quality avatars. Find the templates at

/Packages/Ready Player Me Core/Runtime/Core/Configurations/

You can click and drag these into the Assets folder to duplicate an AvatarConfig that you can then edit.

Create an Avatar Configuration

  1. Select Assets > Create > Scriptable Objects > Ready Player Me > Avatar Configuration. This creates a new Avatar Configuration asset in the current folder.

  2. Give your Avatar Configuration a name.

  3. Select your Avatar Configuration to open it in the Inspector.

  4. Change the settings according to your requirements.

Avatar Configuration Settings

  • Mesh LOD: Choose a level of detail (high, medium for 50%, or low for 25%). An example of this can be found in our MultipleQualityAvatarLoading which can be imported via the Unity Package manager under the Ready Player Me Core section.

  • Pose: Choose A Pose or T Pose.

  • Use Hands: Check to include hands with half-body VR avatars.

  • Texture Atlas: Turn on texture atlassing and choose the atlas size. (With texture atlas enabled avatars will come with 1 single mesh)

  • Texture Size Limit: Set an upper limit on texture size.

  • Texture Channel: Define which texture channels to include or exclude

  • Shader Override: This property can be used to define a custom shader you want the avatar to be loaded with.

    • The texture channel properties nested under the Shader Override can be used to map the textures to the appropriate shader properties

  • Use Draco Compression: If enabled, loaded avatars will use Draco mesh compression.

  • Use Mesh Opt Compression: If enabled, loaded avatars will use Mesh Opt compression.

  • Morph Targets: List of individual morph targets or morph target standard groups to include on the avatar. Click Add and then select your target from the menu.

Apply an Avatar Configuration

Avatar Configurations can be applied in the Unity Editor Avatar Loader or at runtime.

Editor Avatar Loader

  1. Open your scene.

  2. Open Ready Player Me > Settings.

  3. Assign an Avatar Configuration to the Avatar Configuration setting.

  4. Open Ready Player Me > Avatar Loader.

  5. Assign your avatar URL.

  6. Click Load Avatar into the Current Sence. The specified avatar with the specified Avatar Configuration is loaded into the current scene.

Runtime Avatar Object Loader

  1. In your code, create an instance of AvatarObjectLoader.

  2. [Optional] Load a previously created Avatar Configuration asset or instantiate a new Avatar Configuration scriptable object and set its parameters.

  3. [Optional] Assign the Avatar Configuration to the AvatarConfig property of the AvatarObjectLoader instance.

  4. Call the LoadAvatar() method on the AvatarLoader instance, passing a valid avatar URL.

  5. The Avatar Configuration assigned to the URL will be applied to the loaded avatar.

If no Avatar Configuration is assigned to an AvatarObjectLoader instance, the Avatar Configuration selected in the Ready Player Me Settings window is applied.

Examples

Find example usage of Avatar Configurations in the SDK Runtime Examples at

Assets\Samples\Ready Player Me Core\[VERSION_NUMBER]\AvatarLoadingSamples\.

See the Avatar API page for details on these options.

If using Mesh Opt Compression you need to ensure that you have the com.unity.meshopt.decompress plugin imported into your project. Steps to add this package can be found .

See also .

👩‍💻
3D Avatars
here
More Examples