Rendering Plugins Installation

In order to avoid plugin loading conflicts, the Golaem Installer only installs one rendering plugin version per renderer. This version can be checked in the Supported Rendering Engine section of each version of the Release Notes. For some rendering engines, several versions of the Golaem rendering plugin are available. These versions can be checked in the Also Supported section of each version of the Release Notes. Even if they're extracted during installation, those plugins need to be manually installed to replace the default installed one.

Plugins Directory Structure

Rendering plugins are stored in the procedurals/ directory of the Golaem installation directory and respect the following rule:

[GolaemDir]/procedurals/[renderingengine]/[minVersion]

Where:

  • [renderingengine] is the rendering engine name in lower case. Valid values are arnold, guerilla, mentalray, redshift, renderman and vray
  • [minVersion] is the minimal rendering engine version supported by this plugin. The correspondance between rendering engine version and directory name can be found in the Release Notes: eg. Arnold - Mtoa 4.0.X, 4.1.X / KtoA 3.0 - (/60) means that the plugin for Mtoa 4.0.X, Mtoa 4.1.X and Ktoa 3.0 is installed in procedurals/arnold/60

Notice that some rendering plugins also have a [GolaemDir]/extensions/ and/or [GolaemDir]/shaders/ which are following the same rule than the [GolaemDir]/procedurals/ directory

Plugins Installation for Maya

The installed version of a rendering plugin for Maya can be edited in the Golaem module file glmCrowd.mod. This file can be located in two places:

  • In the user profile (if using Windows with the default installation options): <User>/Documents/maya/XXXX/modules
  • At the root of the Golaem Installation directory

When unsure of the location, one can launch the Golaem Render Checker and check the details in the Script Editor or run the glmGetRendererVersionInfo() MEL command:

glmGetRendererVersionInfo();
[GOLAEM RENDER CHECKER]
[...]
   * Please edit the Golaem module file OR the renderer environment variables values to add support for alternate renderer version
   *   - Golaem Module Path: glmCrowd.mod - C:/Users/chaverou/Documents/maya/2018/modules
   *   - Renderer Env Vars: ARNOLD_PLUGIN_PATH, MTOA_EXTENSIONS_PATH, ARNOLD_PROCEDURAL_PATH, PATH

Arnold

The lines to edit in the Golaem module file for Arnold with the desired [minVersion] directory name instead of XX are the following.

MTOA_EXTENSIONS_PATH +:= extensions/arnold/XX
ARNOLD_PROCEDURAL_PATH +:= procedurals/arnold/XX
ARNOLD_PLUGIN_PATH +:= shaders/arnold/XX

Redshift

The lines to edit in the Golaem module file for Redshift with the desired [minVersion] directory name instead of XXXX are the following.

REDSHIFT_PROCEDURALSPATH +:= procedurals/redshift/XXXX
REDSHIFT_MAYAEXTENSIONSPATH +:= extensions/redshift/XXXX

Renderman

The lines to edit in the Golaem module file for Renderman with the desired [minVersion] directory name instead of XX are the following.

RFM_SITE_PATH := procedurals/renderman/XX

VRay

The lines to edit in the Golaem module file for VRay with the desired [minVersion] directory name instead of XX are the following.

VRAY_FOR_MAYAYYYY_PLUGINS +:= procedurals/vray/XX
VRAY_FOR_MAYA_SHADERS +:= shaders/vray/XX

Plugins Installation for other DCCs

Please refer to the Installation parts of each Golaem For DCC documentation.