By installing this software you indicate that you have read and agree to the
terms of its license, found in license.txt (located in the same folder as these
instructions).

To install Contour Rig Tools, you need to copy its files to the appropriate
locations on your drive. The three components are:

 - ContourRigTools.so, the Maya plugin
 - Contourlib, the python package
 - Contour Rig Tools' icons

Throughout this document, we will refer to the directory to which you extracted
the contents of the Contour Rig Tools archive as UNPACKED_DIR.

Installing the Maya Plug-in
---------------------------

ContourRigTools.so must be placed in the Maya plug-ins directory, or a directory
included in the MAYA_PLUG_IN_PATH environment variable. The default plug-ins
directories are:

/usr/autodesk/maya<version>/bin/plug-ins
~/maya/<version>/plug-ins

Make sure to replace <version> in these paths with the appropriate Maya version,
and to copy the plugin to the folder corresponding to your Maya version, e.g.
UNPACKED_DIR/plug-in/maya2024/ContourRigTools.so for Maya 2024.

Installing Contourlib
---------------------

If you are installing for Maya 2020:

The Contourlib folder located in UNPACKED_DIR/python_packages/2.7 must be placed
in Maya's Python site-packages directory, or a directory included in the Maya
PYTHONPATH environment variable. The default site-packages directory for Maya
2020 is:
/usr/autodesk/maya2020/lib/python2.7/site-packages

If you are installing for Maya 2022:

If you run Maya 2022 in Python 3.7 mode, which is the default mode, the
Contourlib folder located in UNPACKED_DIR/python_packages/3.7 must be placed in
Maya's Python 3.7 site-packages directory, or a directory included in the Maya
PYTHONPATH environment variable. The default Python 3.7 site-packages directory
for Maya 2022 is:
/usr/autodesk/maya2022/lib/python3.7/site-packages

If you run Maya 2022 in Python 2.7 mode, then the Contourlib folder located in
UNPACKED_DIR/python_packages/2.7 must be placed in Maya's Python 2.7
site-packages directory, or a directory included in the Maya PYTHONPATH
environment variable. The default Python 2.7 site-packages directory for Maya
2022 is:
/usr/autodesk/maya2022/lib/python2.7/site-packages

If you are installing for Maya 2023:

The Contourlib folder located in UNPACKED_DIR/python_packages/3.9 must be placed
in Maya's Python site-packages directory, or a directory included in the Maya
PYTHONPATH environment variable. The default site-packages directories for Maya
2023 are:
~/maya/2023/scripts/site-packages
or
/usr/autodesk/maya2023/lib/python3.9/site-packages

If you are installing for Maya 2024:

The Contourlib folder located in UNPACKED_DIR/python_packages/3.10 must be
placed in Maya's Python site-packages directory, or a directory included in the
Maya PYTHONPATH environment variable. The default site-packages directories for
Maya 2024 are:
~/maya/2024/scripts/site-packages
or
/usr/autodesk/maya2024/lib/python3.10/site-packages

Installing Icons
----------------

The icons must be copied to Maya's icons directory, or a directory included in
the XBMLANGPATH environment variable. The default icon directories are:

/usr/autodesk/maya<version>/prefs/icons
~/maya/<version>/prefs/icons

Again, make sure to replace <version> in this path with the appropriate Maya
version.

These environment variables can be changed either in your Maya.env file located
in: ~/maya/<version> or by setting them normally. Again, make sure to replace
<version> in this path with the appropriate Maya version.

Running Contour Rig Tools
-------------------------

Once installed, launch Maya, open the menu Windows > Settings/Preferences >
Plug-in Manager, find "ContourRigTools.so", and click the "Loaded" and "Auto
load" checkboxes next to it. Contour Rig Tools should now be loaded and ready to
use.
