QuickStart Guide

The following guide will walk through setting up the BoxHead character using a One-Click approach and a complete setup from scratch. BoxHead is available in the Samples download pack available on this site. download examples pack here

Super Fast QuickStart Using One-Clicks (BoxHead)

QuickStart Guide to implementing Eyes on a very basic component. The following is designed to get the reader up-and-running as quickly as possible, without any explanation or theory. This guide will use the included Boxhead model for demonstration purposes.

  • Add Boxhead to a blank scene. (These instructions assume a blank scene)
  • Locate Boxhead in the Project window (Assets > Crazy Minnow Studio > Examples > 3D > boxHead.v2 > boxHead.v2
  • Drag the Boxhead model into the Hierarchy window.

Add Boxhead to hierarchy

  • Select the Boxhead object in the scene hierarchy.
  • One-click setup Boxhead:
  • From the menu bar: GameObject > Crazy Minnow Studio > SALSA LipSync > One-Clicks > boxHead.v2
  • Boxhead is now configured.
  • Play the scene: The one-click auto-configures the SALSA and Eyes components.

Normal QuickStart

QuickStart Guide to implementing Eyes on a very basic component. The following is designed to get the reader up-and-running as quickly as possible, with very little detailed explanation or theory; however, it does include the necessary steps for manual configuration. This guide will use the included Boxhead model for demonstration purposes.

Add Boxhead to a blank scene. (These instructions assume a blank scene)

  • Locate Boxhead in the Project window (Assets > Crazy Minnow Studio > Examples > 3D > boxHead.v2 > boxHead.v2
  • Drag the Boxhead model into the Hierarchy window.

Add Boxhead to hierarchy

Eye inspector layout

  • The Eyes component has four sections:
  • System Properties (global properties for the component)
  • Head Configuration (template selection, properties, expressions, and components)
  • Eye Configuration (template selection, properties, expressions, and components)
  • Eyelid Configuration (template selection, properties, expressions, and components)
  • Components provide linkage to your characters animatable parts such as bones, blendshapes, sprites, etc.
  • Expressions are like component containers. For example, if your character has two eyes with multiple directional blendshapes (up, right, down left) for each eye, then you might have two eye expressions with four directional components in each.

Add & setup Eyes

  • Select the Boxhead object in the scene hierarchy.
  • Add a Eyes component to the Boxhead object.
  • From the menu bar: Component > Crazy Minnow Studio > SALSA LipSync > Eyes (click)
  • Using 'Add Component' button in Inspector window: click 'Add Component' > type 'eyes' in the search box > select the 'Eyes' script.

Configure Eyes System Properties

  • Expand the section 'System Properties' (click anywhere on the header).
  • Create and link a QueueProcessor by clicking the 'Add QueueProcessor' button.
  • The header changed from gold to blue (indicating a successful configuration).
  • Note that the Eyes component automatically linked 'boxHead.v2' as the 'Character Root'

Head Configuration settings

  • Expand the section 'Head Configuration' (click anywhere on the header).
  • Select 'Bone_Rotation_XY' from the section 'Head Templates', and select 'YES' to overwrite the current head configuration.
  • Under the heading 'head 0 (config required)', drag the 'boxHead.v2' model from the hierarchy to the red highlighted field labeled 'Bone/Transform'.
  • Link Boxhead to Bone/Transform field
  • The 'Head Configuration' header changed from gold to blue (indicating a successful head configuration). However, the 'System Properties' header has changed again from blue back to gold (indicating a problem). This happened because the head cannot be the same Transform as the 'Character Root' field in 'System Properties').
  • To address the issue above, click the 'Add Parent' button in the 'Character Root' section of 'System Properties'.
  • The 'System Properties' header changed from gold back to blue (indicating a successful configuration).
  • Set the 'Target Offset' field in 'Properties' to X(0), Y(1.4), Z(0).
  • Set the 'Distance' field in 'Properties' to Min(3), Max(3).
  • The head configuration is complete, you can click the 'Head Configuration' header to collapse the section.

Eye Configuration settings

  • Expand the section 'Eye Configuration' (click anywhere on the header).
  • Select 'Blend Shapes' from the section 'Eye Templates', and select 'YES' to overwrite the current head configuration.
  • The template defaults to two eyes (eye 0, and eye 1), since the 'boxHead.v2' model uses a single set of blendshapes to control both eyes, we can click the 'x' on the right side of the 'eye1 (config required)' header to delete the second eye template.
  • Delete 'eye 1' from the template
  • Drag 'boxHead.v2', which is now a child of 'boxHead.v2_root' in the hierarchy, to the 'SkinnedMesh' field of the Up, Right, Down, and Left components sections.
  • Select the 'Blendshape' name that corresponds to the component section name:
  • Up = lookUp
  • Right = lookRight
  • Down = lookDown
  • Left = lookLeft
  • Eye configurations that use the 'BlendShapes' template require a point of reference from which eye tracking calculations can be made.
  • Click the 'Create Gizmo' button to create this point of reference. An 'eye 0_Gizmo' was created and parented to the 'boxHead.v2' model.
    • Create the eye reference gizmo
  • Once the gizmo is created, the button is relabeled as 'Adjust Gizmo', clicking it will lock the inspector, and select the 'eye 0_Gizmo' in the hierarchy so that you can easily position it. For accurate individual eye tracking calculations, you would normally create one gizmo per eye expression and position each gizmo at the center of each eye. However, since the 'boxHead.v2' model uses a single set of blendshapes for both eyes, we only need one gizmo, and we'll position it between the eyes.
    • Adjust the eye reference gizmo
    • Eye gizmo position
  • The button is relabeled as 'Release Gizmo', clicking it will unlock the inspector and select the 'boxHead.v2' model in the hierarchy.
    • Release the eye gizmo
  • Set the 'Distance' field in 'Properties' to Min(3), Max(3).
  • The eye configuration is complete, you can click the 'Eye Configuration' header to collapse the section.

Eyelid Configuration settings

  • Expand the section 'Eyelid Configuration' (click anywhere on the header).
  • Select 'Blend Shapes' from the section 'Eyelid Templates', and select 'YES' to overwrite the current head configuration.
  • The template defaults to two eyelids (eyelid 0, and eyelid 1), since the 'boxHead.v2' model uses a single set of blendshapes to control both eyelids, we can click the 'x' on the right side of the 'eyelid1 (config required)' header to delete the second eyelid template.
  • Delete 'eyelid 1' from the template
  • The template defaults to use upper and lower eyelids, since the 'boxHead.v2' model uses a single blendshape to control the upper and lower lids, change the 'Eyelid Select' field in the 'Properties' section to 'Upper'.
  • Switch eyelid selection to 'Upper'
  • Since the 'boxHead.v2' model does not have independent eyelids, turn off eyelid tracking by unchecking the 'Track Eyes' checkbox.
  • Disable eyelid tracking
  • Drag the 'boxHead.v2' model from the hierarchy to the 'SkinnedMesh' field of the Upper component section, and select the 'blink' blendshape.
  • Congigure blink
  • The eye configuration is complete, you can click the 'Eye Configuration' header to collapse the section.

Eyes is now configured for the included Boxhead model. Click play to try out the Eyes experience with random head and eye movement, and blinking.