Model Setup - LunaCapra/CrewBoom GitHub Wiki

Bones

Certain bones are required to be named in a specific way.
Case matters.

  • The skeleton/root of all bones: This must be named root.
    In Blender, this is the armature object that looks like this:
    image

  • The left and right hand: These must be named handl and handr respectively.

  • The left and right foot: These must be named footl and footr respectively.

  • The lower left and right leg: Must be called leg2l and leg2r respectively.

  • The head: This must be named head.

[!WARNING] The editor will not rename bones automatically.
There will however be a warning if any bones are not named correctly.

Blinking/BlendShapes

Using Blender

You can add Blend Shapes (also known as Shape Keys) under the Object Data Tab of your mesh.
You can view this tab by clicking an icon like this: image

[!WARNING] Only the first Blend Shape found will be used for blinking.
This will be the Blend Shape after image
image

You can edit the Blend Shape by selecting it (important!), then going into edit mode and adjusting your character to look like they are blinking.

Example:

image image

[!TIP] In the game, the Blend Shape will only ever be fully active or fully disabled.
This allows for creating a face textured with closed eyes and swapping it for the normal face with the Blend Shape.
This method provides more freedom but is more complicated.

[!TIP] If your model looks broken or dark in-game when blinking, enable Legacy Blend Shape Normals under the model tab in Unity and build the character bundle again.

Exporting your model

Using Blender

[!NOTE] If your character has blend shapes, make sure the mesh has no other modifiers in its Modifier Tab (image) other than the Armature Deform modifier.
image

  1. Make sure your model has its transforms applied (meaning its scale is a uniform 1, 1, 1).
    The default shortcut for this is selecting your entire model, pressing CTRL + A and selecting All Transforms.
  2. Select your skeleton, mesh and everything else you want to include in your model.
  3. Export your model as an FBX file using the menu under File > Export > FBX (.fbx)
    image
    image
    image
  4. Set the export settings to the following (If the settings are not visible initially, click the image icon in the top right of the export window):
    • Under "Include", enable only Selected Objects under "Limit to" and select Armature, Mesh and Other for "Object Types"
      image
    • Under "Transform", set "Apply Scalings" to FBX All, "Forward" to Y Forward and "Up" to Z up
      image
    • Under "Armature", make sure to disable Add Leaf Bones
      image
    • Disable "Bake Animation"
      image
      You can save these export settings as a preset using the plus icon next to the operator presets dropdown at the top of the settings.

Once these settings have been applied you can navigate to the folder your Unity project is in, go to assets and export your model with the Export FBX button.

Unity Avatar

[!WARNING] The avatar of your model must be set to the type Humanoid and have the associated bones assigned.
You can set this up by selecting your model and navigating to the Rig tab in the inspector.
Make sure to also configure the avatar definition properly with the Configure button.

image

[!NOTE] The editor will warn you if the avatar is not human.