Wiki For riggers

Mutant Tools reference

Every mt command and every shipped block, generated from the source at each release. Searchable, and accurate by construction.

  • 117commands
  • 133blocks
  • 11categories
  • 44control shapes

Commands

All 117 mt methods with full signatures, grouped by the class they come from.

Blocks

All 133 blocks with their options, icons and build commands.

Developer guide

How the block system fits together, and how to write your own.

Start here#

every session
from maya import cmds
from Mutant_Tools.Utils.Rigging import main_mutant

mt = main_mutant.Mutant()
nc, curve_data, setup = mt.import_configs()

Those two lines precede everything else on this site. mt is the whole API; nc, curve_data and setup are the JSON configs that keep naming and defaults out of your rigging code.

Where things live#

PathWhat
Utils/Rigging/tools.pyControls, attributes, colour, nodes, JSON, matrices
Utils/Rigging/kinematics.pyFK, IK, twist, ribbons, spines, deformers
Utils/Rigging/modules.pyBlocks, guides, base rig hierarchy, dev mode
Utils/Rigging/main_mutant.pyThe Mutant class and updates
Blocks/<category>/<block>/One folder per block: launcher JSON, versioned JSON, exec script
config/name_conventions.jsonnc - every suffix and side token
config/rig_setup.jsonsetup - default shapes, colours, axes, groups
config/curves.jsoncurve_data - the control shape library
UI/AutoRigger, BlockBuilder, RigTools, Helpers and the rest of the windows
Docs/AI_MT_COMMAND_RULES.mdCoding rules written for AI assistants

The older Sphinx wiki#

The previous autodoc build is still online at /docs/_build/html/. It covers the same modules in less depth and is no longer regenerated - keep it bookmarked only if you have old links pointing into it.

Writing a block?

The developer guide walks the whole lifecycle, from the launcher JSON through the build loop to shipping a v002 without breaking last year's scenes.