Setup

Set up the Unity Editor

• As per the Getting Started section for installing the latest supported Unity editor version and acquiring the Basis framework.
• Open Unity Hub and add an existing project, choose the extracted/cloned Basis project folder
• On the initial project load you will see the following prompt, please hit 'Restart Editor'.

• Once the project has loaded, you can now load in your Avatar files:
• Either,
  • Find Assets in the Project hierarchy, inside Assets right-click any empty space and select Show in Explorer
  • Copy in your Avatar files [Mesh/Materials/Textures, etc.]
• or
  • Import a .unity package containing your files, from the Assets menu, Import Package > Custom Package
• Bring back the Unity window and allow the import process to finish.

Import Model

• Find the location of your Avatar model (usually provided in .FBX format).
• Click the file and then navigate to the Model section of the Import Settings window.
• Ensure that Red/Write and Legacy Blend Shape Normals are selected as below.

• Navigate to the Rig section of the Import Settings window.
• Click the Animation Type drop-down menu and select Humanoid, press Apply as shown below.

• Afterward, the Configure button above Apply is now selectable, click this and then check your bone mappings.

• This should show all mandatory bones as selected; make sure this looks correct for your Armature.
• Lastly, click on the Head button in the Mapping window and remove the assignment for the Jaw; this is usually incorrect.

Skinned Mesh Setup

• There are currently no requirements to name your Avatar's Skinned Mesh as Body or other variation used on Virtual Platforms.
• If you have multiple skinned meshes, consider pinning them to all use the same reference point on the body, for inheriting light probes in the scene. You can do this by assigning a bone from the Armature (Usually Hips) to the Anchor Override field.

• Another consideration for Avatars with multiple Skinned Meshes is when different bounding box sizes cause individual meshes to pop in and out while the rest of the Avatar is visible to remote viewers.
• You can override the Center X, Y, Z & Extent X, Y, Z values in the section named Bounds at the top of the Skinned Mesh Renderer component. Usually, it is a good idea to set this the same across the separate Skinned Meshes.

Materials/Shaders

• You can jump straight in with the Universal Render Pipeline/Lit shader that comes with Unity 6
• Otherwise, we have compiled a list of compatible Avatar Shaders that you can use.

Basis Avatar Setup

• The steps above should automatically add an Animator component to your Avatar prefab when you pull it into the Scene.
• On the Parent GameObject of the Avatar, click Add Component, and add Basis Avatar.
• Enter your preferred Avatar Name and Description.
• In Assigned Input, ensure an Animator is assigned. Usually, this will automatically be done for you. Additionally, assign the Skinned Mesh Renderers which contain the face and blink blendshapes for your avatar. You can also add an optional thumbnail icon for your avatar if you like.
• In Viseme Setup, assign the relevant visemes and blinking for your avatars. You can also use the automatic detection buttons which will try to automatically do this for you.
• Optionally, you can test your avatar in the editor by first entering play mode and then selecting the Test in Editor option.
• Before selecting Create Avatar Bee File, ensure that all your shaders are compatible. The BEE file will not generate if there are incompatible shader errors on your avatar (this includes clothing and attachments). If there are any issues, the inspector will report about it so make sure to resolve them!

Constraints Setup

Basis does not use the built-in Unity Constraints system, instead it uses Animation Rigging. You can find the setup guide here.