Maya Plugin Configuration

Supported versions

The redshift4maya plugin binaries are located in the Redshift installation directory. The default directories for each operating system are listed below.

Windows: C:\ProgramData\Redshift\Plugins\Maya
Linux: /usr/redshift/redshift4maya
macOS: /Applications/redshift/redshift4maya

Redshift supports Maya 2014, 2015, 2016, 2016.5, 2017, 2018, 2019 and 2020 on Windows, Linux and macOS

Plugin Installation

Windows

The Redshift installer for Windows will register the redshift4maya plugin based on the versions of Maya you selected on the ' Select target DCC applications' installer page. This is done by modifying the Maya.env file(s) for the particular version(s) of Maya that were selected. This section describes how to perform the same steps that the installer performs automatically, as well as an alternative method of registering the redshift4maya plugin (using a module file).

The redshift4maya plugin installation directory includes batch files that let you perform the same registration step that is performed during installation. These batch files can be used, for example, if Maya is installed after Redshift and you wish to register the redshift4maya plugin without reinstalling Redshift. Simply run the batch file associated with the particular version of Maya with which you want to register the redshift4maya plugin. For example, to regsiter redshift4maya with Maya 2016, run the batch file install_redshift4maya_2016-64.bat.

An alternative method of registering the redshift4maya plugin is to use a Maya module file. Create a file named redshift4maya.mod with the containing the following text (adjust the Maya version as necessary) and place the file in one of Maya's module directories (e.g. Documents\maya\modules).

+ MAYAVERSION:2019 redshift4maya any C:\ProgramData\Redshift scripts: Plugins/Maya/Common/scripts icons: Plugins/Maya/Common/icons plug-ins: Plugins/Maya/2019/nt-x86-64 MAYA_CUSTOM_TEMPLATE_PATH +:= Plugins/Maya/Common/scripts/NETemplates REDSHIFT_MAYAEXTENSIONSPATH +:= Plugins/Maya/2019/nt-x86-64/extensions REDSHIFT_PROCEDURALSPATH +:= Procedurals REDSHIFT_COREDATAPATH := PATH +:= bin

Linux

The first time you install Redshift on a system, you will need to perform an additional step so that Maya can correctly locate the redshift4maya plugin and script files.

This can be accomplished either by creating a Maya module file for Redshift, modifying the Maya.env file or by defining system environment variables. We recommend using a Maya module file as it requires the fewest steps as is the least prone to errors.

Create a file named redshift4maya.mod file in the module search path of the version(s) of Maya you are running. By default, all versions of Maya will include ~/maya/modules in the module search path.

A template redshift4maya.mod file is included in the Redshift installation directory for reference. Simply copy redshift4maya.mod.template to ~/maya/modules/redshift4maya.mod (create the 'modules' directory if it doesn't exist). If you have installed Redshift to an alternate location, the template will have already been customized with your alternate install location. The redshift4maya.mod.template file from a default installation to /usr/redshift is shown below.

+ MAYAVERSION:2018 redshift4maya any /usr/redshift/redshift4maya scripts: common/scripts icons: common/icons plug-ins: 2018 REDSHIFT_COREDATAPATH = /usr/redshift MAYA_CUSTOM_TEMPLATE_PATH +:= common/scripts/NETemplates REDSHIFT_MAYAEXTENSIONSPATH +:= 2018/extensions REDSHIFT_PROCEDURALSPATH += $REDSHIFT_COREDATAPATH/procedurals + MAYAVERSION:2017 redshift4maya any /usr/redshift/redshift4maya scripts: common/scripts icons: common/icons plug-ins: 2017 REDSHIFT_COREDATAPATH = /usr/redshift MAYA_CUSTOM_TEMPLATE_PATH +:= common/scripts/NETemplates REDSHIFT_MAYAEXTENSIONSPATH +:= 2017/extensions REDSHIFT_PROCEDURALSPATH += $REDSHIFT_COREDATAPATH/procedurals + MAYAVERSION:2016.5 redshift4maya any /usr/redshift/redshift4maya scripts: common/scripts icons: common/icons plug-ins: 2016.5 REDSHIFT_COREDATAPATH = /usr/redshift MAYA_CUSTOM_TEMPLATE_PATH +:= common/scripts/NETemplates REDSHIFT_MAYAEXTENSIONSPATH +:= 2016.5/extensions REDSHIFT_PROCEDURALSPATH += $REDSHIFT_COREDATAPATH/procedurals + MAYAVERSION:2016 redshift4maya any /usr/redshift/redshift4maya scripts: common/scripts icons: common/icons plug-ins: 2016 REDSHIFT_COREDATAPATH = /usr/redshift MAYA_CUSTOM_TEMPLATE_PATH +:= common/scripts/NETemplates REDSHIFT_MAYAEXTENSIONSPATH +:= 2016/extensions REDSHIFT_PROCEDURALSPATH += $REDSHIFT_COREDATAPATH/procedurals + MAYAVERSION:2015 redshift4maya any /usr/redshift/redshift4maya scripts: common/scripts icons: common/icons plug-ins: 2015 REDSHIFT_COREDATAPATH = /usr/redshift REDSHIFT_MAYAEXTENSIONSPATH +:= 2015/extensions REDSHIFT_PROCEDURALSPATH += $REDSHIFT_COREDATAPATH/procedurals + MAYAVERSION:2014 redshift4maya any /usr/redshift/redshift4maya scripts: common/scripts icons: common/icons plug-ins: 2014 REDSHIFT_COREDATAPATH = /usr/redshift REDSHIFT_MAYAEXTENSIONSPATH +:= 2014/extensions REDSHIFT_PROCEDURALSPATH += $REDSHIFT_COREDATAPATH/procedurals

macOS

The installer for macOS automatically installs a module file for each version of Maya it detects on your system. If you have Maya installed in a non-standard location, or you install Maya after installing Redshift, you should copy the template module file /Applications/redshift//redshift4maya/redshift4maya.mod.template to a location that is part of Maya module search paths. Note that the copy of the module template file redshift4maya.mod.template should be renamed to redshift4maya.mod.