U5 Metarig Workflow
====================

Setup Your Metarig
------------------------

To Get Started, you can start by reading the Guideline carefully

.. image:: /images/U5MetarigWorkflow.png


and then You can Pick From One of the Starting Pose we provide

- U5 Rest Pose (Default)
- U5 A Pose
- T Pose
- X Pose (Experimental)
- U4 A Pose

Choose the pose that match cloesest to your Mesh

Create Your Metarig
------------------------

You can Now Click Create U5 Metarig 

.. image:: /images/CreateU5Metarig.png

You can choose if you want to bring in a Face Rig or Not Through this Option

Adjust Your Metarig
----------------------

After you have Created Your metarig, the scene size and the camera will be adjusted to fit the unreal scaling

Now its the time to edit and finetune the metarig to match your model

Some Important Note:

- Do Not Separate bone ball joints
- Do not modify bone's names 

In this Stage, you can Merge External Rig you want into the Metarig Using the Rigify Intergration Section

If You Want to reset your progress, you can click DELETE ALL RIGS & RESET SCENE 

After Your Metarig Matches your Model, you can now Click Generate U5 Rig


Binding / Weight 
----------------------

Now that you have your Generated Skeleton, you can proceed to Bind your Mesh to the Armature

In this stage, you can Add your Mesh using the Add Selected Button under "BIND these objects"

Once you added the object, you can click Bind Weights to perform an Automatic Weights on the Mesh Object in the List

You can then proceed to work on your weight painting

You may use Detach Root Rig  / Attach to Control Rig depending on your needs for weight painting purposes

Some Tools Such as "Copy Weight From Selection" and "Normalize and Smooth" is provided to help you in your weight painting process

You can Also use the Weight Transfer Tool to transfer weight from One Object onto Multiple Object



Animate
-----------

Once you have done your weight painting process and the mesh is properly bounded to the skeleton, you can now Proceed to Animate Your Character

Remember to Push your Animation onto the NLA Tracks for exporting purpose later


Export
-----------

After You have done your Animation, make sure all the animation you want to export is pushed to the NLA

You then can click FBX to U5 to export your Rig, Mesh and Animation into FBX

The Addon Will Display the Action that will be Baked and Exported into FBX in the Side Panel

Send to Unreal
-----------------

Your Rig is Now Ready and you can import into unreal for use