Rigamajig2 is a modular data-centric rigging tool for Autodesk Maya. It provides a straightforward method of creating and connecting componets to create complex rigs.
- Rigamajig2 currently only supports Python 2. While compatiablity with Python 3 is being developed if using Maya 2022 or 2033 please change your Python version to version 2 in the global variables.
To install rigamajig2 on your computer:
-
Download the latest version from the git repository
-
Unzip it
-
Copy the rigamajig2-master folder somewhere on your hard drive. If you're unsure of a good place the Maya modules folder is a good bet.
Windows: Users<username>Documents/Mayamodules
Linux: ~/maya/modules
Mac OS X:/Users/<username>/Library/Preferences/Autodesk/maya/modules
-
Open Autodesk Maya
-
Navigate to the
drag_into_maya.py
file located within the package -
drag the
drag_into_maya.py
file into your viewport
Rigamajig2 has two methods to utilize the tool:
- The framework (available through python)
- The BuilderUI (a more straightforward PySide interface)
To launch the UI run the following code in python
import rigamajig2.ui.builder_ui.dialog as builder_dialog
builder_dialog.BuilderDialog.showDialog()
More documentation to come
To reload all rigamajig2 modules in a python session run the following code
import rigamajig2
rigamajig2.reloadModule()
Rigamajig2 adheres to some general coding practices. To test any additions made the run the following command:
cd path/to/rigamajig2
pylint scripts/rigamajig2
Or if you using PyCharm configure your project to use the rigamajig2/scripts
folder
as the content root. Then you can run:
pylint rigamajig2
Rigamajig2 comes with unitesting capiblilities.
To run tests run the python command
located in the bin at rigamajig2/bin/testrigamajig
.
cd path/to/rigamajig2/bin
python testrigamajig
Added unittests must be subclasses of the base unittest class.To setup your own unittest confugure your test as shown below:
from rigamajig2.maya.test.mayaunittest import TestCase
class TestSomething(TestCase):
def test_someSuperCoolTest(self):
""" Your awesome test goes here"""
pass
Documentation can be auto-generated using sphinx.
when new modules are added please cd into rigamajig2/docs
and run the following to generate .rst
files for all modules
sphinx-apidoc -o source scripts
To build the HTML Documentatino run:
make html
Rigamajig2 development blog: https://www.masonsmigel.com/blog
Questions? email me at [email protected]!