Environment Variables List

When installed through a classic installation, there is not extra environment variable to be set in order to run Golaem Crowd (except golaem_LICENSE when a license is needed).

However, when deploying Golaem Crowd as a Maya module, or on the Render Farm, you may need to set some environment variables.

Notice that some of these variables may already be defined by system or custom scripts. It is then recommended not to replace the existing value, but append the Golaem Crowd related value to the existing value, using the appropriate separator (a ";" separator on Windows or a ":" separator on Linux).

Licence Variables

golaem_LICENSE
            or
RLM_LICENSE

These variables are not needed if using the Golaem Crowd plugin for rendering only (see license setup) or when using the auto-generated evaluation license.

Contains the full path to the Golaem license file to use ( (or license server information using the port@hostname format).

Any of these variables can be used (only one is needed), but it maybe more convenient to use the golaem_LICENSE variable to avoid issues with other software using RLM.

GLMCROWD_LAYOUT_LICENSE Set this variable to 1 if you want to force a computer to use a LAYOUT license instead of a FULL license (typically on a lighting artist computer who needs only to visualize/edit simulation cache, or on a computer used only to batch export the simulation). See License Types for more details
GLMCROWD_BATCH_ENABLE  Set this variable to 1 if you want to enable a computer to perform batch simulation export. The default value is 0 which prevents any computer to use a license while used in batch (so that Maya does not trigger simulation during rendering). The command glmBatchCrowdSimulationExporter set this variable temporary when called.
GLMCROWD_NO_LICENSE  Set this variable to 1 if you want to skip the fetch of a Golaem Crowd license on a computer (such as a render node for example).

Maya Module Variable

When using advanced deployment, it may be needed to set this variable for Maya to find and load the Golaem Crowd module. See Advanced Installation

MAYA_MODULE_PATH

Contains the path to the directory where the glmCrowd.mod file is located (e.g. the Golaem Crowd installation directory when using standard installation C:\Golaem\GolaemCrowd-5.X-Maya201X).

Other Variables

These variables are mandatory for Golaem Crowd to work correctly and their values should be checked in case a problem arise. However, they should never need to be set manually, as they are set by the Golaem Crowd Maya Module file.

They are here for your reference when investigating a problem, for people wanting to control them in their own scripts or render with stand-alone versions of their renderer.

Generic Variables

The following variables are mandatory in order to successfully load the Golaem Crowd plugin and are required to render with any of the rendering engine listed below:

PATH
(Window only)

Contains the path to the directory where the dependant binaries required by Golaem Crowd plugin are located (e.g. the bin/ folder in Golaem Crowd installation directory when using standard installation).

LD_LIBRARY_PATH
(Linux only)

Contains the path to the directory where the dependant libraries required by Golaem Crowd plugin are located (e.g. the lib/ folder in Golaem Crowd installation directory when using standard installation).

This variable may be required only on some specific Linux distributions.

Renderers Specific Variables

The following variables are mandatory only if using the related renderers:

3Delight

DL_PROCEDURALS_PATH

Contains the path to the directory where the Golaem Crowd plugin for 3Delight is located (e.g. the procedurals/ folder in Golaem Crowd installation directory when using standard installation).

Arnold

ARNOLD_PROCEDURAL_PATH

Contains the path to the directory where the Golaem Crowd plugin for Arnold is located (e.g. the procedurals/ folder in Golaem Crowd installation directory when using standard installation).

ARNOLD_PLUGIN_PATH

Contains the path to the directory where the Golaem Crowd shaders for Arnold are located (e.g. the shaders/ folder in Golaem Crowd installation directory when using standard installation).

Mental Ray

MI_CUSTOM_SHADER_PATH

Contains the path to the directory where the Golaem Crowd plugin for Mental Ray is located (e.g. the procedurals/ folder in Golaem Crowd installation directory when using standard installation).

Renderman Studio

RMS_SCRIPT_PATHS

Contains the path to the directory where the Renderman Studio 18 or 19 .ini files are located (e.g. the procedurals/ folder in Golaem Crowd installation directory when using standard installation). This variable is used by Renderman Studio to find ini files which will define its workspace.

RMS_PROCEDURAL_PATH

Contains the path to the directory where the Golaem Crowd plugin for Renderman Studio 18 or 19 is located (e.g. the procedurals/ folder in Golaem Crowd installation directory when using standard installation).

RMS_SHADER_PATH

Contains the path to the directory where the Golaem Crowd shaders for Renderman Studio 18 and 19 are located (e.g. the shaders/ folder in Golaem Crowd installation directory when using standard installation).

V-Ray

VRAY_PLUGINS_x64

(only for stand alone rendering)

Contains the path to the directory where the Golaem Crowd plugin for V-Ray is located  (e.g. the procedurals/ folder in Golaem Crowd installation directory when using standard installation).

VRAY_FOR_MAYA2014_PLUGINS_x64
                          or
VRAY_FOR_MAYA2013_PLUGINS_x64
                          or
...

Contains the path to the directory where the Golaem Crowd plugin for V-Ray is located  (e.g. the procedurals/ folder in Golaem Crowd installation directory when using standard installation).

Notice that the name of the variable itself is depending on the Maya version you are using. It is particularly important to keep the default value of this variable and only append the Golaem Crowd value, or V-Ray rendering will not work at all.

VRAY_FOR_MAYA_SHADERS Contains the path to the directory where the Golaem Crowd shaders for V-Ray are located (e.g. the shaders/ folder in Golaem Crowd installation directory when using standard installation).

If VRAY_FOR_MAYA_SHADERS contains multiple paths, V-Ray does not read any other path after encountering an empty path, so watch out carefully its contents to avoid any shaders issue when rendering. To fix this, refer here. This issue has been solved from V-Ray 3.10.01

VRAY30_RT_FOR_3DSMAX2015_PLUGINS_x64

(only for 3dsMax, adapt the VRay and 3ds Max version)

Contains the path to the directory where the Golaem Crowd plugin for V-Ray is located  (e.g. the procedurals/ folder in Golaem Crowd installation directory when using standard installation).

Note that this variable is only needed when rendering with the 3ds Max + VRay plugin. See the tutorial for full workflow description.

It is particularly important to keep the default value of this variable and only append the Golaem Crowd value, or V-Ray rendering will not work at all.