Skip to content

TrevisanGMW/gt-tools

Repository files navigation

GitHub contributors GitHub language count GitHub last commit GitHub forks GitHub stars GitHub issues GitHub license GitHub stars

Description

This is my collection of scripts for Autodesk Maya – These scripts were created with the aim of automating, enhancing or simply filling the missing details of what I find lacking in Maya.

After installing or running the script collection, you’ll find a pull-down menu that provides easy access to a variety of tools and utilities. This menu contains sub-menus that have been organized to contain related tools, for example: modeling, rigging, utilities, etc…

For help on how to use these scripts, click on the “Help” button at the top right of their window (within Maya) or check their documentation by going to the docs folder. For changelog see the releases page.

All of these items are supplied as is. You alone are solely responsible for any issues. Use at your own risk. Hopefully these scripts are helpful to you as they are to me.

Note: Python 2 is no longer supported. If you want to still use an older versions of Maya, make sure to use a GT-Tools version below "3.0.0" for compatibility.

Package tested using Autodesk Maya 2022, 2023 and 2024 (Windows 11)

Organization

  • docs: Documentation on installation, usage, and troubleshooting of the package and its tools.
  • gt.tools: The "tools" directory contains separate folders, each representing a distinct tool.
  • gt.ui: The "ui" module provides utilities for user interface operations.
  • gt.utils: The "utils" module is a set of reusable functions that are not tied to any specific tool.
  • tests: Package unittests for tools, ui and utilities. See CONTRIBUTING for more details.

Setup (Install, Uninstall, Run Only)

TL;DR: Download and extract the files; Drag and drop the file "setup_drag_drop_maya.py" onto the Maya viewport; Select the option "Install", "Uninstall" or "Run Only"; Enjoy!

GT Tools Installation Tutorial

This script collection comes with an auto setup tool ("setup_drag_drop_maya.py") to call it drag and drop the file on your Maya viewport. From the setup window you can "Install", "Uninstall" or "Run Only".
Here is how you do it in more details:

  1. Open Maya (in case it's closed).
  2. Download the latest release (or clone this repository).
  3. Un-zip (Decompress) the file you downloaded. (the setup won't work if it's still compressed)
  4. Drag and drop "setup_drag_drop_maya.py" on to your Maya viewport.
  5. An user interface with the setup options will open.
  6. Select the desired operation. E.g. "Install", "Uninstall", or "Run Only"
  7. Enjoy!

After installing, you can delete the downloaded/extracted files (as they have already been copied)

Setup Window

GT Tools Installation Setup Window

  1. Install: Copies the files to the installation path and loads (reloads) the package.
  2. Uninstall: Deletes the files from the installation path and unloads the package.
  3. Run Only: "One time use only"; Loads tools from current location without copying files.

Checksum Verification

When installing it for the first time, Maya might show you a small dialog window saying "UserSetup Checksum Verification", you can confirm it with a "Yes". This window is only letting you know that the "userSetup.mel" script was modified. This is a security feature from Autodesk that is used to tell the user that the startup script was modified. This check is used to prevent infected scenes from modifying the startup script without the user knowing. In our case, we did it deliberately as part of the installation process, so you can just confirm it.

Run Only

The setup window offers the option to run the tools without installing them. To do this, follow the same drag and drop steps and click on "Run Only" instead of "Install". This is going to load the tools from the location you have them, allowing you to run it one time only.

Updating

Simply install it again. The auto setup will handle the file changes.
If updating a major version, it's recommended that you uninstall it first before installing it again. This will eliminate any unnecessary files.
In case updating it manually, make sure to overwrite (replace) the files when moving them.

Contributors

If you'd like to contribute, see the CONTRIBUTING file for a detailed explanation on how to do that.
Pull requests are warmly welcome.

Looking for other ways to contribute? You could buy me a coffee! ☕ or use the Github sponsor ❤️ options!
This is definitely a huge motivation boost! 🤩

Licensing

The MIT License 2020 - Guilherme Trevisan