Studio install

Since version 0.1.20, TheKeyMachine has been free and does not require a license to operate. It can also be used on offline machines.

TheKeyMachine allows for centralized installation, enabling multiple users to use a single installation and license.

TheKeyMachine works like a Python package. It has a JSON configuration file where the installation path can be specified.

For a studio installation, the 'TheKeyMachine' folder should be taken as a package and copied wherever desired. The drag & drop file within TheKeyMachine_installer.zip is only for personal installations.

The JSON file is located inside /TheKeyMachine/data/config and contains the following code:

{
    "STUDIO_INSTALL": false,
    "INSTALL_PATH": "",
    "USER_FOLDER_PATH": "",
    "LICENSE_FOLDER": "",
    "LICENSE_FILE_NAME": "",
    "UPDATER": false,
    "BUG_REPORT": true,
    "CUSTOM_TOOLS_MENU": true,
    "CUSTOM_SCRIPTS_MENU": true,
    "CUSTOM_TOOLS_EDITABLE_BY_USER": true,
    "CUSTOM_SCRIPTS_EDITABLE_BY_USER": true
}

When nothing is specified in the JSON configuration, TheKeyMachine operates in 'Personal' mode, not in 'Studio' mode. In 'Personal' mode, it defaults to using Maya's standard paths, with Maya's user folder as the base directory (e.g., /home/user/maya/scripts)."

In a studio setup, you'll likely want to modify these paths.

For instance, if you're looking to install TheKeyMachine package on a Linux system, you might choose the following directory: /pipeline/tools/animation

For storing data generated by the script, such as caches and user-specific data, you might use: /pipeline/users/USER/scripts

And for the license file, named "license_key" for example, you might place it in: /pipeline/licenses/TheKeyMachine

You should have received the 'license_key' file upon registration. If not, you can use the key recovery function, and the system will resend the license file to you. [Key Recovery]

With this configuration, the JSON file should look as follows:

{
    "STUDIO_INSTALL": true,
    "INSTALL_PATH": "/pipeline/tools/animation",
    "USER_FOLDER_PATH": "/pipeline/users/{USERNAME}/scripts",
    "LICENSE_FOLDER": "/pipeline/licenses/TheKeyMachine",
    "LICENSE_FILE_NAME": "license_key",
    "UPDATER": false,
    "BUG_REPORT": true,
    "CUSTOM_TOOLS_MENU": true,
    "CUSTOM_SCRIPTS_MENU": true,
    "CUSTOM_TOOLS_EDITABLE_BY_USER": true,
    "CUSTOM_SCRIPTS_EDITABLE_BY_USER": true
}

The {USERNAME} placeholder should be used to insert the current user's name into the path If we want the user's script folder to remain Maya's default folder, we can leave the USER_FOLDER_PATH entry empty. In this case, TheKeyMachine will use Maya's default path (/home/user/maya/scripts).

Certain parameters of TheKeyMachine can be adjusted, which basically consist of hiding or showing certain features to the users. For example, hiding the option to report bugs, or the custom menus.

Once Maya is launched with the appropriate configuration and TheKeyMachine package is loaded, it can be launched by executing the code:

import TheKeyMachine TheKeyMachine.toggle()

In Studio mode, if a valid license is not found, the user will see a lock icon on the toolbar, similar to in Personal mode.

However, clicking on it will only display a warning window. The Studio version removes the ability for users to uninstall or add licenses.

Last update: 21st January 2024