Avatar Ready Tools

The following tools are included in Avatar Ready:

Avatar Importer

This tool helps creating the avatar bundle to use with avatar ready.

AvatarReady_ARImporter

The main use case of the Avatar Importer is to generate asset bundle for the avatars to be uploaded to an Avatar Gallery. It can also be used to:
- Download avatar assets to use as static avatars in a project.
- Download avatar assets in a resource folder to be used runtime avatars built in the project.
Path configuration:
- Avatar Project Folder: project folder used to store avatars during pipeline execution.
- Unzip Exe: Path to a file archiver executable.
- Upload path: AvatarGallery remote folder.
Avatar configuration:
- Render pipeline: Render pipeline targeted for the avatars.
- Provider: Avatar provider.
- Avatar Quality: Avatar preset quality when importing the avatar.
- Max texture size: Maximal texture quality.
- Setup Pipeline: Add required packages for the selected provider
- Clean up Packages: Remove packages specific to the selected provider

Avatar Gallery configuration: This parameters are to be modified in the AvatarReady project settings.

The pipeline configuration:

  • Download avatars: Download avatars from the avatar gallery, selectable avatars will be listed from the avatar gallery

  • Import Avatars / Create Prefab: Create a prefab asset from the fbx. If download avatars is not checked, selectable avatars will be listed from fbx assets

    • Create metadata file: Create metadata json file for imported avatars

    • Create preview image: Create a preview image for imported avatars

    • Import As Resources: Prefabs, metadata and preview are generated in a resource folder. Use this option if you plan to use the avatar as Runtime avatar but want the asset to be included in the project build

  • Build Avatars: Create an AssetBundle file for the avatar. If previous options are not selected, selectable avatars will be listed from prefabs in Assets/AvatarReady/Avatars

  • Upload Avatars: Upload AssetBundles to the upload path. If previous options are not selected, selectable avatars will be listed from AssetBundles in Assets/AvatarReady/avatars

    • Upload FBX: Upload the fbx file with the AssetBundle

      • Overwrite FBX: Overwrite FBX files on the server

    • Upload metadata: Upload the metadata with the AssetBundle

      • Overwrite metadata: Overwrite metadata files on the server

    • Upload Preview: Upload preview image with the AssetBundle

      • Overwrite Preview: Overwrite preview images on the server

  • Delete local file: Remove all files created localy by the pipeline

Select Avatars: Select avatars to include in the pipeline. Available avatars are determined by the first option selected. Select All: Select all available avatars for this pipeline configuration

Execute pipeline: Launch the pipeline. This process can take a long time depending on the number of avatars.

Replay Manager

The Replay Manager tool allows you to manage multiple animated avatars within the same scene.

AvatarReady_ReplayManager

If there are no Replay Manager in the current scene, a button to Add Replay Manager will be displayed. Otherwise settings for the Replay Manager will be available.

Note

It is recommended to have only one Replay Manager per scene. The tool will only display settings for the first detected instance.

Replay Manager global settings:

  • Play on load: automatically starts playing animations when the avatar is loaded.

  • Sync All Avatar Animations: Ensures all avatars are fully loaded before starting animations.

  • Loop Animations: Enable continuouse loop of animations.

You can add an avatar by clicking the Add Avatar Button.

Avatar settings:

  • Asset Bundle Name: Define which avatar will be loaded.

  • Target Game Object: A placeholder object where the avatar will be placed.

  • Position & Rotation: Sets the avatar’s initial transform in the scene.

  • Animation Type: The type of animations used one the avatar (.anim file or .json)

  • Animation Name: Path of the animation to play.

To remove an avatar, click the Remove button under the avatar Settings’

Avatar Explorer

The avatar explorer displays the avatars available on the avatar gallery and those available in the local avatar folder. This allows you to preload avatars that you will need.

Click the Load Avatar button to download an avatar to the local avatar folder.

Click the Remove button to delet an avatar from the local avatar folder.

AvatarReady_AvatarExplorer

XR Rig helper

The XR RIg Helper tool assists in setting up a VR Rig that can be applied to an avatar.

AvatarReady_XRRigHelper

Configuring Trackers

The XR Rig Helper contains a list of trackers, each tracker is linked to a body part.

Each tracker is associated with a GameObject Tracking that body part and has a Tracker Type.

The tracker type provides predefined offsets for the tracked.

Managing Trackers

To add a tracker, select the corresponding body part, and click the Configure New Tracker button.

To remove a tracker, click the - button on the tracker’s row.

Setting Up Effectors

Click Setup Effectors to create effectors for each tracker.

An effector serve as a reference point the tracker targeted body part. You can apply position and rotation offsets to the effector to better align the tracker with the tracked body part.

Click Reset Effectors to remove all existing effectors.

Applying the Rig to an Avatar

  • Set an AvatarReady component to the Avatar ready target object field.

  • Press the Apply Rig button to link the effectors to the corresponding tracker on the avatar.

Warning

The avatar’s config must have the same trackers as the XR Rig Helper