Linux

Command-Line Installation (Silent Mode)

A Golaem package called GolaemCrowd-4.X-Maya201X.run can be installed from command-line in silent mode (without any interactive setup nor GUI window) using the -- silent option:

./GolaemCrowd-4.X-Maya201X.run -- silent

Watch out the empty space between the double dash -- and the silent keyword

Package is then installed with default settings. The following options can also be set in any order to customize installation:

<custom_install_path> Install Golaem to a custom location ("~/Golaem/GolaemCrowd-4.X-Maya201X" by default). 
no_mod_install Prevent installing Golaem module in Maya current user files (installed by default).
In this case, apply custom setup to make Golaem available in Maya plugin manager.

For example, the following command will install the GolaemCrowd-4.X-Maya201X.run package at location /home/user/Golaem/GolaemCrowd-4.X-Maya201X without installing Golaem module file in Maya current user files:

./GolaemCrowd-4.X-Maya201X.run -- silent /home/user no_mod_install

Command-Line Basic Extraction (Extract Mode)

Simply extracting files from package requires to process a custom setup.

Files can be simply extracted from a Golaem package called GolaemCrowd-4.X-Maya201X.run using the -- extract option:

./GolaemCrowd-4.X-Maya201X.run -- extract

Watch out the empty space between the double dash -- and the extract keyword

Files are directly extracted in current working directory, but it is possible to specify a custom extract directory. For example, the following command will extract files from the GolaemCrowd-4.X-Maya201X.run package at location /tmp/GolaemCrowd-4.X-Maya201X:

./GolaemCrowd-4.X-Maya201X.run -- extract /tmp

Custom Setup

By default, the Golaem installer makes Golaem available in Maya plugin manager for current user by copying the glmCrowd.mod module file from Golaem Crowd installation directory to Maya current user files (located in maya/201X-x64/modules in current user home directory).

This is an easy way to setup Golaem for current user, but not appropriate to make Golaem available in Maya for several users or to switch between several installed Golaem versions. In these cases, it is necessary to tell Maya where to find the glmCrowd.mod module file by setting its directory (e.g. the Golaem installation directory) into the MAYA_MODULE_PATH environment variable (see how to set environment variables).

For example, if a Golaem Crowd package is installed in /home/user/Golaem/GolaemCrowd-4.X-Maya201X directory, then the glmCrowd.mod module file is located in this directory and the MAYA_MODULE_PATH environment variable must contain this directory:

MAYA_MODULE_PATH = /home/user/Golaem/GolaemCrowd-4.X-Maya201X

Individual users wishing to install the module by themselves or site administrators wishing to install a common copy of the module for multiple users should follow the following steps:

  • Extract, move or copy the module's entire directory tree to a directory which is accessible to all users, such as a network drive
  • Replace the fourth field of the glmCrowd.mod file with the full path to the module's directory tree
  • Place a copy of the modified glmCrowd.mod file into a common directory which all users have in their MAYA_MODULE_PATH environment variable

List Of Installed Module Files

To simplify multi-file plugin distribution, Maya provides the ability to package them into modules. The Golaem Crowd plugin module consists of a root directory which contains the following files and sub-directories:

glmCrowd.mod 

Module file to be referenced by Maya for loading the plugins (through the MAYA_MODULE_PATH environment variable).
brushes/

Directory containing the brushes icons used for specific tools.
fonts/

Directory containing the fonts used.
icons/

Directory containing the icons used for the Maya shelf.
lib/

Directory containing the libraries required by the Golaem plugin. It should be reference in the LD_LIBRARY_PATH environment variable.
plug-ins/

Directory containing the Golaem plugin.
procedurals/

Directory containing the procedural rendering plugins for each supported renderer. It should be referenced in a specific renderer variable for procedural rendering to work correctly (see Render Farm Deployment for details).
scripts/

Directory containing the MEL scripts used by the Golaem Crowd plugin.
shaders/

Directory containing procedural shaders for some specific renderers (Arnold, V-Ray):

  • glmCrowdArnoldShaders.so and glmCrowdArnoldShaders.mtd: Arnold procedural shaders. 
  • glmCrowdVRayPlugin.txt: header for the V-Ray procedural shaders
  • glmCrowdRMS_REYES_Shaders.h: header for the RenderMan REYES procedural shaders.
  • glmCrowdRMS_RIS_GetUserDataShader.dll, glmCrowdRMS_RIS_HSLShader.dll and glmCrowdRMS_RIS_SwitchShader.dll: RenderMan RIS procedural shaders.
CHANGELOG List of changes done at each version udpate.
DISCLAIMER Important notice about supported compatible renderers, displayed when installing Golaem package.
LICENSE License file displayed when installing Golaem package.
PLUGINS List of current version of plugin/shader for each available renderer.
uninstall.sh/ Script to run in order to uninstall the Golaem package. Obviously this scritps should not be included in a network installation.