Links

Avatar Configuration

Apply Avatar API parameters to avatar loading.
The Ready Player Me Avatar API allows partners to specify the Avatar Configuration parameters to be applied 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.
See the Avatar API documentation for details.
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 templateas at
/Assets/Plugins/Ready Player Me/Resources/Data/Avatar Configurations/

Create an Avatar Configuration

  1. 1.
    Select Assets > Create > Scriptable Objects > Ready Player Me > Avatar Configuration. This creates a new Avatar Configuration asset in the current folder.
  2. 2.
    Give your Avatar Configuraton a name.
  3. 3.
    Select your Avatar Configuration to open it in the Inspector.
  4. 4.
    Change the settings according to your requirements.

Avatar Configuration Settings

See Avatar API 3D Avatars for details on these options.
  • Mesh LOD: Choose a level of detail. Run Ready Player Me > Examples > Runtime Example > RuntimeExampleMultipleQuality to see how this looks.
  • Pose: Choose A Pose or T Pose.
  • Texture Atlas: Turn on Texture Atlassing and choose the atlas size.
  • Texture Size Limit: Set an upper limit on texture size.
  • Use Hands: Check to include hands with half-body VR avatars.
  • 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 extensive menu.

Apply an Avatar Configuration

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

Editor Avatar Loader

  1. 1.
    Open the desired scene.
  2. 2.
    Open Ready Player Me > Settings.
  3. 3.
    Assign an Avatar Configuration to the Avatar Configuration setting.
  4. 4.
    Open Ready Player Me > Avatar Loader.
  5. 5.
    Assign the desired avatar URL.
  6. 6.
    Click Load Avatar into the Current Scence. The specified avatar with the specified Avatar Configuration is loaded into the current scene.

Runtime Avatar Loader

  1. 1.
    In your code, create an instance of AvatarLoader.
  2. 2.
    [Optional] Load a previously created Avatar Configuration asset or instantiate a new Avatar Configuration scriptable object and set its parameters.
  3. 3.
    [Optional] Assign theAvatar Configuration to the AvatarConfig property of the AvatarLoader instance.
  4. 4.
    Call the LoadAvatar() method on the AvatarLoader instance, passing a valid avatar URL.
  5. 5.
    The Avatar Configuration assigned to the URL will be applied to the loaded avatar.
If no Avatar Configuration is assigned to an AvatarLoader 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 located in:
Assets\Plugins\Ready Player Me\Examples\Runtime Example\
See als More Examples.