Skip to main content

Maya Plug-In Configuration

Please ensure you have a valid license and it's installed correctly before proceeding. Refer to the licensing page for more details.

Once downloaded please extract Yeti to a suitable location - a good choice for Windows would be C:\Program Files\ and Linux /opt/local/.

info

We highly recommend storing the Yeti distribution in a directory corresponding to the version you're using. This results in only a few environment variables needing to change to use the new release.

Maya Module Configuration

Yeti's distribution leverages Maya's Module scheme, where a single .mod file, located in the installation root, can define the locations of all plugins, scripts, and icons required for Yeti's functionality.

You will need to edit the pgYetiMaya.mod file, which resides in the root directory of the Yeti distribution. Replace path_to_yeti_root with the complete path to the Yeti root directory (which is likely the directory where the file is situated).

Environment Variables

To use the previously edited .mod file, you'll need to set the environment variable MAYA_MODULE_PATH to point to the directory where the file is located.

Additionally, if you're installing Maya on Windows, you'll also need to add the Yeti bin directory to your global PATH environment variable.

Loading the Plug-In

Once you've completed the installation, you can load the plug-in from Maya's plug-ins window by selecting pgYetiMaya.so/dylib/dll from the plug-ins manager.

info

This is the only plugin you will need to worry about loading, all of the other extensions will be loaded automatically when required.

Step by Step Walkthrough

Here is a step by step walkthrough of the above process for a Yeti 5.0 release on Windows.

  1. Download the distribution Yeti-v5.0.0_Maya2024-windows.zip from the Yeti Downloads page (or the latest version).
  2. Extract this to a directory Yeti-v5.0.0_Maya2024-windows which is the same name as the distribution
  3. Move this directory to a sane location on your system, for this example Yeti-v5.0.0_Maya2024-windows will be moved to Program Files
  4. Open pgYetiMaya.mod and set the path to C:\Program Files\Yeti-v5.0.0_Maya2024-windows (or your sane location as per step 3)
  5. Open Maya.env file in C:\Users\username\Documents\maya\2024 and add MAYA_MODULE_PATH = C:\Program Files\Yeti-v5.0.0_Maya2024-windows (or your sane location as per step 3)

You should now be able to see and load pgYetiMaya.mll in the Maya plugins window.

warning

If you have a Maya.env file in C:\Users\username\Documents\maya it will override anything set in the version subdirectory.