View source for Modding: Maya Exporter

[[File:MayaExporter_StepByStep.png|center]]
<sub> The exporter tool window in Maya 2015</sub>

<br/>
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya <b>2015</b> on Windows.
|-
|}

<br />
== Components ==
<sub>This article references the image at the top of the page</sub>


The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup

<br />
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
<sub> The animation manager </sub>

<br />
<p>This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. <br />
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, <br />
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.</p>
<br />

<p>This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations.<br />
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*</p>
<br />

<p>Already present entries are found when selecting the root dummy with the data present. <br />
New entries can be made with the new button on the bottom.</p>
<br />

<p>Obsolete entries can be removed with the delete button while the entry is selected.<br />
Double clicking any of the fields of an entry allows to edit the data within the field.</p>

<p>The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses.<br \>
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks</p>

<br />

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
<sub> The multi layer exporter </sub>

<br />
<p>The Multi Layer Exporter is the workhorse of this script package.<br />
It is responsible for exporting models, physics and animations to their correct formats.</p>
<br />

<p>Most cases will only show the top left hand panel with the layers currently available in the scene. <br />
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. <br />
A Layer should contain the relevant model and its matching physics. </p>
<br />

<p>Physics are expected to have the _Phys suffix<br />
Rig Bones are expected to have _Bone or Bone_ in their name</p>
<br />

<p>The layer name determines the exported file name:<br />
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet</p>
<br />

<p>The _Base suffix tells the MLE that the layer contains a character rig. <br />
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. </p>
<br />

<p>The Right Hand panel becomes available when the animation checkbox is checked. <br />
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. <br />
If it finds such a folder it will list all the maya files available in the folder. <br />
When exporting, animations are put within a folder with the name of the base file.</p>
<br />

<p>Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. <br />
These files won’t allow model or physics exports.</p>
<br />

<p>The bottom History Panel keeps track of where you have exported already. <br />
The paths created are dependent on the provided data path. <br />
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.</p>
<br />

<p>On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. <br />
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. <br />
If the source doesn’t match up exports are done within the base folder of the mod.</p>
<br />

<p>The actual export button is on the bottom left.<br />
The delete and clear all button are for the path history panel.</p>
<br />

<p>The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name.<br />
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported.<br />
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.</p>
<br />

<p>Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.</p>

<br />

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
<sub> The advanced export settings </sub>

<br />
==== Edit Export Settings ==== 
Allows you to change the granny preset during export. <br />
Most likely you’ll never need this in a mod export.<br />

==== Single Character Export ==== 
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. <br />
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. <br />
This is active by default for a Base Layer export.<br />

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. <br />
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present.<br \>
This is also overriden by the Export Variable Setup Make vertex Coloured<br />

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. <br />
It tries to catch any export errors occurring and write them in a debug log which is shows after export.<br />

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. <br />
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. <br />
Maya standalone is used by default for exporting Animations from a base file.<br />

==== Animation Quality ====
This dropdown list lets you define different compression setting for animation export.<br \>
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

<br />

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
<sub> Data path editor </sub>

<br />
<p>The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. <br />
The Modify Path script allows you to set up and modify the path saved. <br />
The MLE will throw a warning when this isn’t done before its first launch.</p>


<br />
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
<sub> Variable setup window </sub>

<br />
<p>The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. <br />
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present.</p><br />

<p>Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. <br />
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. <br />
These dummies also signify attachments of e.g. shields/swords on arms/hands. This export setting is required to export your custom attachment locations. <br />
Works on current selection.</p><br />

<p>Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. <br />
The object needs to have vertex colour applied and the variable this button adds to indicate it needs to be treated as a simulated object. <br />
Works on current selection.</p><br />

<p>Make Vertex Coloured is specifically for meshes that have vertex colours, but won't be cloth simmed. <br />
Only used by MLE to determine inclusion of vertex colours during export. <br \>
Works on current selection.</p><br />

<p>Make Proxy Mesh is specifically for meshes that are going to be used as emitter proxies in effect. The MLE automatically changes the export settings for these objects if this setting is found. <br />
Works on current selection.</p><br />

<p>Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. <br />
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene.</p><br />

<br />

===Setting up Physics in Maya for the MLE===

To set up physics we use the bullet.mll plugin. This plugin should come shipped with every install of maya. <br \>
If the plugin is active you should have a bullet shelf tab. If it isn't active go to Top Menu -> Window -> Settings/Preferences -> Plug-in Manager<br \>
Look for bullet.mll in the list and set it to loaded and auto load.

[[File:bulletActive.png|none]]
<br \>
[[File:bulletShelf.png|none]]

The bullet shelf works on the current selection. To turn a mesh in a physics mesh click the third button in the shelf '''Create a passive Rigid Body Object.<br \>
This will attach a BulletRigidBodyShape to your object. This is what we will edit via the attribute editor.<br \>

The important settings are ''Body type'' and ''Collider Shape Type.''

[[File:staticphysics.png|none]]

For a physics object that can not move the Body type should be set to Static body

[[File:kinematicphysics.png|none]]

For a physics object that can move the Body type should be set to Kinematic RigidBody

'''!!!Important: Don't ever use Dynamic Rigid Body as a body type. This is reserved for ragdolls only!!!'''

Currently supported shape types are:
*Box/Box2D (Plane)
*Sphere
*Capsule
*Convex Hull
*Mesh (Static Only)
*Cylinder

The best supported shape type is hull, but feel free to experiment with the other shape types to see how they work.<br \>
<br \>
To visualize the rigid body shapes look for the bullet solver shape in the outline and check it's ''Solver Display -> Collision Shape'' <br \>
this will draw a wireframe representation of what the bullet plugin thinks your physics mesh looks like.<br \>

[[File:BulletSolverVisualize.png|none]]

'''Note:''' Physics are an approximation of reality you can't have the worlds most complex shapes and expect calculations to go well. Keep it simple first and foremost.