From 8e3da6764819ec1916e353d42d45cec0f6329ca7 Mon Sep 17 00:00:00 2001 From: leixingyu Date: Sat, 22 Jan 2022 20:34:54 -0500 Subject: [PATCH] update readme with pre-requisites --- README.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b3fe4e3..3ec22d1 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ rigging based on modules as well as pre-made template for biped, quadruped and c ## About The Project -
-autoRigger -
+
+autoRigger +
The AutoRigger tool started out as my practice for maya scripting back in late 2018. But Little by little, @@ -28,13 +28,20 @@ in general rigging process. ## Getting Started +### Prerequisites + +- [enum34 package](https://pypi.org/project/enum34/) for Python 2.7 + + `pip install enum34` + +### Launch 1. Unzip the **auto-rigger** package under `%USERPROFILE%/Documents/maya/[current maya version]/scripts/` or a custom directory under `PYTHONPATH` env variable. 2. Rename the package to something like `autoRigger` -3. Launch through script editor: +3. Run through script editor: ```python from autoRigger import autoRigger autoRigger.show() @@ -46,9 +53,9 @@ The autoRigger is modular and very straight forward to use; Each item on the lef individually and piece together to build the final rig; there are also pre-made template for standard characters like biped and quadruped. -**Create Guide** -interface +> note: autoRigger isn't a skinning tool +**Create Guide** - choose a rig object, and then enter specific properties on the right-side field, finally click guide. - this creates a guided locators or the rough joint placement of the rig. @@ -60,17 +67,16 @@ target mesh. - when you are satisfied with the guide placement, click build. it will generate all the joints, controllers and constraints. - The next step if for you to skin your character/creature using anything you -prefer -- note: autoRigger isn't a skinning tool +prefer + +interface -## Scripting API ->Anything GUI can do, scripting can do better; +## Scripting Example the rig object and all of its components can be accessed through scripting with ease, as each rig object is a class inheriting the abstract bone class. -### Example: To instantiate a rig object, build guide and rig ```python from autoRigger.constant import Side