Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes how to set up your local system environment to load and run the correct version of V-Ray from zip.

UI Text Box
typenote

Starting with V-Ray 6, the Portable Installation replaces the zip builds. Please visit the Portable Installation page to find out more.

 

 

Expand
titleClick here for the zip installation setup for earlier versions of V-Ray
UI Button
colorblue
newWindowtrue
icondownload
titleDownload V-Ray 5 for Maya
urlhttps://download.chaosgroup.com/?platform=48&product=47

...


Overview


Installing V-Ray for Maya from a .zip file provides several advantages over the regular installer:

Fancy Bullets
typecircle
  • The ZIP installation allows for setting a custom environment when starting each Maya instance. In
difference
  • comparison, running the regular installation multiple times overwrites the V-Ray environment variables.
  • The ZIP installation can be used to run V-Ray for Maya and V-Ray Standalone from
an arbitrary
  • any location or even a network drive. That way, multiple users can start Maya along with V-Ray
for Maya
  • using just a script that sets up the environment variables without the need to run local installations.
  • Upgrading a ZIP installation is a lot easier too, as you don't need to run the installer on every user's computer.
  • The ZIP installation allows for
quickly
  • quick switching between different V-Ray versions without reinstalling it.

When installing V-Ray for Maya from a .zip file, note that Chaos Cosmos is not included by default in the installation. To add it, you can

...

separately download and install it.

When using a ZIP-installed V-Ray, the EULA needs to be accepted to start a render. A pop-up window appears when rendering begins. Only Batch rendering is an exception to this.

...

UI Text Box
typeinfo

Starting with version 5, update 2, V-Ray is notarized through the Apple Notarization service. The Notarization verifies App Bundle vendors and we've modified our V-Ray plugin for Maya accordingly. This means we can no longer officially distribute zip installations for macOS going forward, as Zip installations are not "bundles" and cannot be notarized. Zip builds for macOS are still available as stable builds on the nightly server.

Required steps to run V-Ray


To

 

Required steps to run V-Ray

...

size

run a ZIP installation, you will need to:

  1. Unpack the ZIP file to a location of your choice

  2. Set up the environment variables needed to run V-Ray for Maya and/or V-Ray Standalone

  3. Set up your license

  4. Run Maya or V-Ray Standalone

 

UI Text Box
sizemedium
typetip

An easy way to complete the environment set up and run Maya or V-Ray Standalone is with a custom shell or bat script that sets the environment for running the application instance.

These steps are further discussed in the sections below with examples.

UI Text Box
medium
typenote

It is highly recommended to only use V-Ray from a ZIP install or from a regular installation, but never both at the same time. If you plan on using the ZIP install, make sure to uninstall V-Ray beforehand.

Anchor
unpack_zip
unpack_zip

 

Unpacking the .zip file


Extract the contents of the relevant .

...

zip file into a suitable folder. After unpacking, there should be three sub-folders:

...

 maya_root,

...

 maya_vray,

...

and vray.

Below is a step-by-step guide:

 

 

Tabs Container
directionhorizontal
Tabs Page
titleWindows

 

  1. Download V-Ray 5 for Maya 2020 (Zip) from the Chaos website. The file should be called vray_adv_51020_maya2020_x64.zip.
  2. Make a new directory anywhere on your machine or on a network location and call it (for example) vray_builds. For the purposes of our example, create a vray_builds directory on your D:\ drive.
  3. Make another directory inside vray_builds and name it vray_51020_maya2020.
  4. Unpack vray_adv_51020_maya2020_x64.zip into the vray_51020_maya2020 directory. Three new sub-folders should appear: maya_rootmaya_vray, and vray
UI Text Box
typeinfo

The D:\ drive holding the vray_builds folder is simply an example. The unpacked V-Ray ZIP installation can be placed anywhere.

Sectioncolumn

 

width10%

 

Column
width30%

At this point, your folder structure should look like this:


D:\vray_builds\
├── vray_51020_maya2020\
│ ├── maya_root\
│ ├── maya_vray\
│ └── vray\

Column
width10%

 

Column
width30%

Here is an example with V-Ray 5 for Maya 2020 and V-Ray Next for Maya 2020 - each can be deployed with its own shell script and environment.

D:\vray_builds\
├── vray_51020_maya2020\
│ ├── maya_root\
│ ├── maya_vray\
│ └── vray\
├── vray_40401_maya2020\
│ ├── maya_root\
│ ├── maya_vray\
│ └── vray\

Column
width20%

 

Tabs Page
titleLinux

 

  1. Download V-Ray 5 for Maya 2020 (Zip) from the Chaos website. The file should be called vray_adv_51020_maya2020_centos7.zip.
  2. Make a new directory anywhere on your machine or on a network location and call it (for example) vray_builds. For the purposes of our example, create a vray_builds directory on your /opt/ directory.
  3. Make another directory inside vray_builds and name it vray_51020_maya2020.
  4. Unpack vray_adv_51020_maya2020_centos7.zip into the vray_51020_maya2020 directory. Three new sub-folders should appear: maya_rootmaya_vray, and vray
UI Text Box
typeinfo

The /opt directory on Linux is simply an example. The unpacked V-Ray ZIP installation can be placed anywhere.

width
Section
Column

 

10%

 

Column
width30%

At this point, your folder structure should look like this:


/opt/vray_builds/
├── vray_51020_maya2020/
│ ├── maya_root/
│ ├── maya_vray/
│ └── vray/

Column
width10%

 

Column
width30%

Here is an example with V-Ray 5 for Maya 2020 and V-Ray Next for Maya 2020 - each can be deployed with its own shell script and environment.

/opt/vray_builds/
├── vray_51020_maya2020/
│ ├── maya_root/
│ ├── maya_vray/
│ └── vray/
├── vray_40401_maya2020/
│ ├── maya_root/
│ ├── maya_vray/
│ └── vray/

Column
width20%

 

Tabs Page
titlemacOS

 

  1. Download V-Ray 5 for Maya 2020 (Zip) from the Chaos website. The file should be called vray_adv_51020_maya2020_mavericks_x64.zip.
  2. Make a new directory anywhere on your machine or on a network location and call it (for example) vray_builds. For the purposes of our example, navigate to your root directory using cd / and create a vray_builds directory.
  3. Make another directory inside vray_builds and name it vray_51020_maya2020.
  4. Unpack vray_adv_51020_maya2020_mavericks_x64.zip into the vray_51020_maya2020 directory. Three new sub-folders should appear: maya_rootmaya_vray, and vray
UI Text Box
typeinfo

The / root directory is simply an example. The unpacked V-Ray ZIP installation can be placed anywhere.

10%
Section
Column
width

 

 

Column
width30%

At this point, your folder structure should look like this:


/vray_builds/
├── vray_51020_maya2020/
│ ├── maya_root/
│ ├── maya_vray/
│ └── vray/

Column
width10%

 

Column
width30%

Here is an example with V-Ray 5 for Maya 2020 and V-Ray Next for Maya 2020 - each can be deployed with its own shell script and environment.

/vray_builds/
├── vray_51020_maya2020/
│ ├── maya_root/
│ ├── maya_vray/
│ └── vray/
├── vray_40401_maya2020/
│ ├── maya_root/
│ ├── maya_vray/
│ └── vray/

Column
width20%

 

UI Text Box
typetip

After unpacking the zip file, set up the environment to run V-Ray for Maya and V-Ray Standalone or set up an environment to only run V-Ray Standalone.

 

V-Ray Material Library Browser


The V-Ray Material Library Browser can be installed using

...

the mtllib

...

 tool that comes with the .zip file. Once unpacked, it resides in the following location:

Winunpack_zip_folder\maya_vray\bin\mtllib.exe

Linux: unpack_zip_folder/maya_vray/bin/mtllib.bin

macOS: unpack_zip_folder/maya_vray/bin/mtllib.bin

For more information on how to run the mtllib tool,

...

see Material Library Installation.

 

Environment setup

...

UI Text Box
typenote

In V-Ray

...

6, the V-Ray Material Library Browser is replaced by the Chaos Cosmos Browser. Please use the materials from the Chaos Cosmos Browser for any new projects.

If the V-Ray Material Library folder has not been downloaded with a previous V-Ray version and its folder is empty, clicking on the V-Ray Material Library Browser button from the V-Ray toolbar opens Chaos Cosmos Browser. The mtllib.exe tool is still available and downloads the V-Ray Material Library.

 

Environment setup


Before you run Maya оr V-Ray Standalone, you need to set up an environment. There are some specific steps to consider for Maya, XGen with Maya and V-Ray Standalone. The license setup is the last requirement, as V-Ray needs to be instructed where to look for a valid license.

Please read the sections below for more information and examples.

Anchor
env_setup_maya
env_setup_maya

Setup for Maya


The following environment variables and tags need to be set when running Maya with V-Ray.

Please read the sections below for more information and examples.

...

Setup for Maya

The following environment variables need to be set when running Maya with V-Ray.

UI Text Box
typetip

In the examples below, nnnn is the Maya version, for example 2018 or 2020, etc. For example VRAY_FOR_MAYA2020_MAIN or VRAY_FOR_MAYA2020_PLUGINS, etc.

UI Text Box
typetip

V-Ray 5 comes with material presets. To load the presets, the MAYA_PRESET_PATH environment variable needs to be set.

Windows

Tabs Container
directionhorizontal
Tabs Page
title

The example directory and version names below are for V-Ray 5 for Maya 2020 on Windows where vray_adv_51020_maya2020_x64.zip has been unpacked into D:\vray_builds\vray_51020_maya2020\.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below

.

UI Text Box
typetip

In the examples below, nnnn is the Maya version, for example 2018 or 2020, etc. For example VRAY_FOR_MAYA2020_MAIN or VRAY_FOR_MAYA2020_PLUGINS, etc

info
note
UI Text Box
type
tip

V-Ray 5

, update 1 introduces changes to the PATH and MAYA_RENDER_DESC_PATH environment variables.

Note that for Windows, the \bin\hostbin and \bin locations must be added in this order to the PATH variable.

To set up the environment for V-Ray 5, see the setup for older versions of V-Ray.

comes with material presets. To load the presets, the MAYA_PRESET_PATH environment variable needs to be set.

MAYA_RENDER_DESC_PATH 

set VRAY_FOR_MAYA2020_MAIN=
Tabs Container
directionhorizontal
OSActionVariableLocationDescriptionExample
WindowsSet
Anchor
1.11.1<unpacked_zip_location>\maya_vray\rendererDescNeeded to run batch rendering with Maya.set MAYA_RENDER_DESC_PATH=D:\vray_builds\vray_51020_maya2020\maya_vray\rendererDescWindowsSet

VRAY_FOR_MAYAnnnn_MAIN 1

<unpacked_zip_location>\maya_vray

Loads the V-Ray for Maya plugins.
Tabs Page
titleWindows
UI Text Box
typeinfo

The example directory and version names below are for V-Ray 5 for Maya 2020 on Windows where vray_adv_51020_maya2020_x64.zip has been unpacked into

D:\vray_builds\vray_51020_maya2020\

maya_vray

.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

UI Text Box
typenote

V-Ray 5, update 1 introduces changes to the PATH and MAYA_RENDER_DESC_PATH environment variables.

Note that for Windows, the \bin\hostbin and \bin locations must be added in this order to the PATH variable.

To set up the environment for V-Ray 5, see the setup for older versions of V-Ray.

OSActionVariableLocationDescriptionExample
WindowsSet

MAYA_RENDER_DESC_PATH

Anchor
1.1
1.1
WindowsSet

VRAY_FOR_MAYAnnnn_PLUGINS 1.1

Anchor2.22.2<unpacked_zip_location>\maya_vray\vrayplugins

Loads the V-Ray plugins.

set VRAY_FOR_MAYA2020_PLUGINS=D:\vray_builds\vray_51020_maya2020\maya_vray\vraypluginsWindowsSetVRAY_PLUGINS 2 Anchor1.2.1.21.2.1.2
<unpacked_zip_location>\maya_vray\
vrayplugins
rendererDescNeeded
for V-Ray Standalone
to run batch rendering with Maya.set
VRAY_PLUGINS
MAYA_RENDER_DESC_PATH=D:\vray_builds\vray_51020_maya2020\maya_vray\
vrayplugins
rendererDesc
WindowsSet

VRAY_

OSL

FOR_

PATH

MAYAnnnn_

MAYAnnnn 

MAIN1

.2

<unpacked_zip_location>\maya_vray

\opensl

Loads
OSL plugins for
the V-Ray for Maya plugins.set VRAY_
OSL
FOR_
PATH
MAYA2020_
MAYA2020
MAIN=D:\vray_builds\vray_51020_maya2020\maya_vray
\opensl
Windows
Extend
Set

PATH

<unpacked

VRAY_

zip_location>\maya_vray\bin\hostbin;<

FOR_MAYAnnnn_PLUGINS 1.1

Anchor
2.2
2.2
<unpacked

unpacked

_zip_location>\maya_vray\

bin

vrayplugins

Loads the

Required to run

V-Ray

itself

plugins.

set
PATH
VRAY_FOR_MAYA2020_PLUGINS=D:\vray_builds\vray_51020_maya2020\maya_vray\
bin\hostbin;
vrayplugins
WindowsSet

VRAY_PLUGINS 2

Anchor
1.2.1.2
1.2.1.2

<unpacked_zip_location>\maya_vray\vraypluginsNeeded for V-Ray Standalone.set VRAY_PLUGINS=D:\vray_builds\vray_51020_maya2020\maya_vray\
bin;%PATH%
vrayplugins
Windows
Extend
Set
MAYA
VRAY_
PLUG
OSL_
IN_PATH
PATH_MAYAnnnn 1.2<unpacked_zip_location>\
maya_
vray\
plug-ins
openslLoads
the
OSL plugins for V-Ray
for Maya main plugins
.set
MAYA
VRAY_
PLUG
OSL_
IN
PATH_
PATH
MAYA2020=D:\vray_builds\vray_51020_maya2020\
maya_
vray\
plug-ins;%MAYA_PLUG_IN_PATH%
opensl
WindowsExtend
MAYA_SCRIPT_

PATH

 

<unpacked_zip_location>\maya_vray\bin\hostbin;<unpacked_zip_location>\maya_vray\
scriptsLoads the
binRequired to run V-Ray
for Maya scripts
itself.set
MAYA_SCRIPT_
PATH=D:\vray_builds\vray_51020_maya2020\maya_vray\bin\
scripts;%MAYA_SCRIPT_PATH%
hostbin;D:\vray_builds\vray_51020_maya2020\maya_vray\bin;%PATH%
WindowsExtendMAYA_PLUG_
PRESET
IN_PATH<unpacked_zip_location>\maya_vray\
presets
plug-insLoads the V-Ray
material presets
for Maya main plugins.set MAYA_PLUG_
PRESET
IN_PATH=D:\vray_builds\vray_51020_maya2020\maya_vray\
presets
plug-ins;%MAYA_PLUG_
PRESET
IN_PATH%
WindowsExtend
PYTHONPATH
MAYA_SCRIPT_PATH<unpacked_zip_location>\maya_vray\scriptsLoads the V-Ray
python
for Maya scripts.set
PYTHONPATH
MAYA_SCRIPT_PATH=D:\vray_builds\vray_51020_maya2020\maya_vray\scripts;
%PYTHONPATH%
%MAYA_SCRIPT_PATH%
WindowsExtend
XBMLANGPATH Anchor3.33.3
MAYA_PRESET_PATH<unpacked_zip_location>\maya_vray\
icons
presets
Loads the V-Ray
icons
material presets.set
XBMLANGPATH
MAYA_PRESET_PATH=D:\vray_builds\vray_51020_maya2020\maya_vray\
icons;%XBMLANGPATH%
presets;%MAYA_PRESET_PATH%
Windows
Set
ExtendPYTHONPATH
VRAY
<unpacked_
AUTH
zip_
CLIENT_FILE_PATH 3arbitrary locationPoints V-Ray to a V-Ray license.
location>\maya_vray\scriptsLoads the V-Ray python scripts.set PYTHONPATH=D:\vray_builds\vray_51020_maya2020\maya_vray\scripts;%PYTHONPATH%
set VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>
WindowsExtend
MAYA_CUSTOM_TEMPLATE_PATH
XBMLANGPATH

<unpacked_zip_location>\maya_vray\

scripts

icons

Anchor
3.3
3.3

Loads the
node editor and lookdev templates
V-Ray icons.set
MAYA_CUSTOM_TEMPLATE_PATH
XBMLANGPATH=D:\vray_builds\vray_51020_maya2020\maya_vray\
scripts;%MAYA_CUSTOM_TEMPLATE_PATH%
icons;%XBMLANGPATH%
WindowsSet
MAYA
VRAY_
TOOLCLIPS
AUTH_
PATH <unpacked
CLIENT_
zip_location>\maya_vray\toolclipsEnables toolclips for
FILE_PATH 3arbitrary locationPoints V-Ray to a V-Ray license.set
MAYA_TOOLCLIPS
VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>
WindowsExtend

MAYA_CUSTOM_TEMPLATE_PATH

<unpacked_zip_location>\maya_vray\scriptsLoads the node editor and lookdev templates. set MAYA_CUSTOM_TEMPLATE_PATH=D:\vray_builds\vray_51020_maya2020\
toolclips
maya_vray\scripts;%MAYA_
TOOLCLIPS
CUSTOM_TEMPLATE_PATH%
 
Windows

 

SetMAYA_TOOLCLIPS_PATH <unpacked_zip_location>\maya_vray\toolclipsEnables toolclips for V-Ray.set MAYA_TOOLCLIPS_PATH=D:\vray_builds\vray_51020_maya2020\toolclips;%MAYA_TOOLCLIPS_PATH%
WindowsExtend

PXR_PLUGINPATH_NAME

AnchorenvSetupV5WinenvSetupV5Win
UI Expand
titleSetup for older versions of V-Ray

For older V-Ray versions, use the setup for V-Ray 5, update 1 from the table above and change the PATH and MAYA_RENDER_DESC_PATH variables as shown.

MAYA_RENDER_DESC_PATH rootbin\rendererDescNeeded to run batch rendering with Maya
OSActionVariableLocationDescriptionExample
WindowsSet

<unpacked_zip_location>\maya_

vray\

usdplugins

Loads USD plugins for V-Ray.

set

MAYA

PXR_

RENDER

PLUGINPATH_

DESC_PATH

NAME=D:\vray_builds\vray_51020_maya2020\maya_

root\bin\rendererDesc

vray\usdplugins:$PXR_PLUGINPATH_NAME

WindowsExtendSetVRAY_APPSDK_PLUGINSPATH<unpacked_zip_location>\maya_rootvray\binvraypluginsRequired to run Loads V-Ray itselfray App SDK plugins.

set

PATH

VRAY_APPSDK_PLUGINS=D:\vray_builds\vray_51020_maya2020\maya_

root\bin;%PATH%
Tabs Page

vray\vrayplugins

 

 

Anchor
envSetupV5Win
envSetupV5Win

titleLinuxtext-box

ui-
UI Text Box
typenote
Expand
typeinfo

The example directory and version names below are for V-Ray 5 for Maya 2020 on Linux where vray_adv_51020_maya2020_linux_x64.zip has been unpacked into /opt/vray_builds/vray_51020_maya2020/.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

titleSetup for older versions of V-Ray

For older V-Ray versions, use the setup for

V-Ray 5, update 1

introduces changes to the LD_LIBRARY_

from the table above and change the PATH and MAYA_RENDER_DESC_PATH

environment variables.

For Linux,  LD_LIBRARY_PATH should no longer be set for V-Ray for Maya and should only be set when running V-Ray Standalone.

To set up the environment for V-Ray 5, see the setup for older versions of V-Ray.

OSAction

 variables as shown.


OSActionVariableLocationDescriptionExample
Linux
WindowsSet

MAYA_RENDER_DESC_

PATH Anchor1.3.1.31.3.1.3

PATH 

<unpacked_zip_location>
/
\maya_
vray/
root\bin\rendererDescNeeded to run batch rendering with Maya.
export
set MAYA_RENDER_DESC_PATH=
/opt/
D:\vray_builds
/
\vray_51020_maya2020
/
\maya_
vray/
root\bin\rendererDesc
Linux
Windows
SetVRAY_FOR_MAYAnnnn_MAIN 1.3
Extend

PATH

<unpacked_zip_location>
/
\maya_
vray
root\binRequired to run
Anchor1.41.4Loads the
V-Ray
for Maya plugins
itself.
export VRAY_FOR_MAYA2020_MAIN=/opt/
set PATH=D:\vray_builds
/
\vray_51020_maya2020
/
\maya_
vray
root\bin;%PATH%
Anchor2.1.2.12.1.2.1export VRAY_FOR_MAYA2020_PLUGINS=
Tabs Page
titleLinux
SetVRAY_FOR_MAYAnnnn_PLUGINS 1.4<unpacked_zip_location>/maya_vray/vraypluginsLoads the V-Ray plugins.
UI Text Box
typeinfo

The example directory and version names below are for V-Ray 5 for Maya 2020 on Linux where vray_adv_51020_maya2020_linux_x64.zip has been unpacked into 

/opt/vray_builds/vray_51020_maya2020

/maya_vray

/

vraypluginsLinuxSet Anchor1

.

5.1.51.5.1.5VRAY_PLUGINS 2.1

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

UI Text Box
typenote

V-Ray 5, update 1 introduces changes to the LD_LIBRARY_PATH and MAYA_RENDER_DESC_PATH environment variables.

For Linux,  LD_LIBRARY_PATH should no longer be set for V-Ray for Maya and should only be set when running V-Ray Standalone.

To set up the environment for V-Ray 5, see the setup for older versions of V-Ray.

OSActionVariableLocationDescriptionExample
LinuxSet

MAYA_RENDER_DESC_PATH

Anchor
1.3.1.3
1.3.1.3

<unpacked_zip_location>/maya_vray/rendererDescNeeded to run batch rendering with Maya.export MAYA_RENDER_DESC
<unpacked_zip_location>/maya_vray/vraypluginsNeeded for V-Ray Standalone.export VRAY_PLUGINS=/opt/vray_builds/vray_51020_maya2020/maya_vray/vraypluginsLinuxSetVRAY_OSL_PATH_MAYAnnnn 1.5<unpacked_zip_location>/vray/openslLoads OSL plugins for V-Ray.export VRAY_OSL_PATH_MAYA2020=/opt/vray_builds/vray_51020_maya2020/vray/openslLinuxExtendMAYA_PLUG_IN_PATH<unpacked_zip_location>/maya_vray/plug-insLoads the V-Ray for Maya main plugins.export MAYA_PLUG_IN
_PATH=/opt/vray_builds/vray_51020_maya2020/maya_vray/
plug-ins:$MAYA_PLUG_IN_PATH
rendererDesc
Linux
Extend
SetVRAY_FOR_MAYA
_SCRIPT_PATH 
nnnn_MAIN1.3<unpacked_zip_location>/maya_vray
/scripts
Anchor
1.4
1.4
Loads the V-Ray for Maya
scripts
plugins.export
MAYA
VRAY_FOR_
SCRIPT
MAYA2020_
PATH
MAIN=/opt/vray_builds/vray_51020_maya2020/maya_vray
/scripts:$MAYA_SCRIPT_PATH
Linux
Extend
Set
MAYA_PRESET_PATH
VRAY_FOR_MAYAnnnn_PLUGINS 1.4<unpacked_zip_location>/maya_vray/
presets
vrayplugins

Loads the V-Ray

material presets.

plugins.

Anchor
2.1.2.1
2.1.2.1

export VRAY_FOR_MAYA2020_PLUGINS
export MAYA_PRESET_PATH
=/opt/vray_builds/vray_51020_maya2020/maya_vray/
presets:$MAYA_PRESET_PATH
vrayplugins
Linux
Extend
Set

Anchor
1.5.1.5
1.5.1.5
VRAY_PLUGINS 2.1

PYTHONPATH

<unpacked_zip_location>/maya_vray/
scripts
vrayplugins
Loads the
Needed for V-Ray
python scripts
Standalone.export
PYTHONPATH
VRAY_PLUGINS=/opt/vray_builds/vray_51020_maya2020/maya_vray/
scripts:$PYTHONPATH
vrayplugins
Linux
ExtendXBMLANGPATH Anchor3.1.3.13.1.3.1
SetVRAY_OSL_PATH_MAYAnnnn 1.5
<unpacked_zip_location>/
maya_
vray/
icons/%B
openslLoads
the
OSL plugins for V-Ray
icons
.export
XBMLANGPATH
VRAY_OSL_PATH_MAYA2020=/opt/vray_builds/vray_51020_maya2020/
maya_
vray/
icons/%B:$XBMLANGPATH
opensl
Linux
Set
Extend
VRAY
MAYA_
AUTH
PLUG_
CLIENT
IN_
FILE_
PATH
3.1
<unpacked_zip_location>/maya_vray/plug-insLoads the V-Ray for Maya main plugins.export MAYA_PLUG_IN_PATH=/opt/vray_builds/vray_51020_maya2020/maya_vray/plug-ins:$MAYA_PLUG_IN_PATH
arbitrary locationPoints V-Ray to a V-Ray license.export VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>
LinuxExtendMAYA_
CUSTOM
SCRIPT_
TEMPLATE_
PATH<unpacked_zip_location>/maya_vray/scriptsLoads the
node editor and lookdev templates
V-Ray for Maya scripts.export MAYA_
CUSTOM_TEMPLATE
SCRIPT_PATH=/opt/vray_builds/vray_51020_maya2020/maya_vray/scripts:$MAYA_
CUSTOM_TEMPLATE
SCRIPT_PATH
Linux
Set
ExtendMAYA_
TOOLCLIPS
PRESET_
PATH 
PATH<unpacked_zip_location>
\
/maya_vray
\toolclips
/presetsLoads the
Enables toolclips for
V-Ray material presets.export MAYA_
TOOLCLIPS
PRESET_PATH=/opt/vray_builds/vray_51020_maya2020/maya_vray/
toolclips
presets:$MAYA_
TOOLCLIPS
PRESET_PATH
 
Linux
anchor
Extend
envSetupV5Linux
PYTHONPATH<unpacked_zip_location>/maya_vray/scriptsLoads the V-Ray python scripts.export PYTHONPATH=/opt/vray_builds/vray_51020_maya2020/maya_vray/scripts:$PYTHONPATH
LinuxExtend

XBMLANGPATH

Anchor
3.

envSetupV5Linux
UI Expand
titleExpand to see the setup...
For older V-Ray versions, use the setup for V-Ray 5, update 1 from the table above and change the LD_LIBRARY_PATH and MAYA_RENDER_DESC_PATH variables as shown in the expandable.

 

MAYA_RENDER_DESC_PATH.3.3rootbinrendererDescNeeded to run batch rendering with Maya
OSActionVariableLocationDescriptionExample
LinuxSet
Anchor

1.3.1

3.1.3.1

<unpacked_zip_location>/maya_vray/icons/Loads the V-Ray icons.export MAYA_RENDER_DESC_PATHXBMLANGPATH=/opt/vray_builds/vray_51020_maya2020/maya_rootvray/binicons/rendererDesc %B:$XBMLANGPATH
LinuxExtend

LD_LIBRARY_PATH

<unpacked_zip_location>/maya_root/libRequired to run V-Ray itself.export LD_LIBRARY_PATH=/opt/vray_builds/vray_51020_maya2020/maya_root/lib:$LD_LIBRARY_PATH
Tabs Page
titlemacOS
The example directory and version names below are for V-Ray 5 for Maya 2020 on macOS where vray_adv_51020_maya2020_mavericks_x64.zip has been unpacked into 
SetVRAY_AUTH_CLIENT_FILE_PATH 3.1arbitrary locationPoints V-Ray to a V-Ray license.export VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>
LinuxExtend

MAYA_CUSTOM_TEMPLATE_PATH

<unpacked_zip_location>/maya_vray/scriptsLoads the node editor and lookdev templates.export MAYA_CUSTOM_TEMPLATE_PATH=/opt
Tabs Page
titleLinux
UI Text Box
typeinfo
/vray_builds/vray_51020_maya2020
/.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

/maya_vray/scripts:$MAYA_CUSTOM_TEMPLATE_PATH
LinuxSetMAYA_TOOLCLIPS_PATH <unpacked_zip_location>/maya_vray/toolclipsEnables toolclips for V-Ray.

export MAYA_TOOLCLIPS_PATH=/opt/vray_builds/vray_51020_maya2020/maya_vray/toolclips:$MAYA_TOOLCLIPS_PATH

LinuxExtend

PXR_PLUGINPATH_NAME

UI Text Box
typenote

V-Ray 5, update 1 introduces changes to the DYLD_LIBRARY_PATH and MAYA_RENDER_DESC_PATH environment variables.

For macOS, DYLD_LIBRARY_PATH should no longer be set for V-Ray for Maya and should only be set when running V-Ray Standalone.

To set up the environment for V-Ray 5, see the setup for older versions of V-Ray.

OSActionVariableLocationDescriptionExamplemacOSSetMAYA_RENDER_DESC_PATH Anchor1.6.1.61.6.1.6

<unpacked_zip_location>/maya_vray/

rendererDescNeeded to run batch rendering with Maya

usdplugins

Loads USD plugins for V-Ray.

export

MAYA

PXR_

RENDER

PLUGINPATH_

DESC_PATH

NAME=/opt/vray_builds/vray_51020_maya2020/maya_vray/

rendererDesc macOS

usdplugins:$PXR_PLUGINPATH_NAME

LinuxSet

VRAY_

FOR_MAYAnnnn_MAIN 1.6

APPSDK_PLUGINS

<unpacked_zip_location>/maya_vray
Anchor1.7.1.71.7.1.7Loads the
/vraypluginsLoads V-Ray
for Maya
App SDK plugins.

export VRAY_

FOR

APPSDK_

MAYA2020_MAIN

PLUGINS=/opt/vray_builds/vray_51020_maya2020/maya_vray/vrayplugins

macOS

 

Set

 

Anchor

2.2.2.2

envSetupV5Linux
envSetupV5Linux

UI Expand
titleExpand to see the setup...
For older V-Ray versions, use the setup for V-Ray 5, update 1 from the table above and change the LD_LIBRARY_PATH and MAYA_RENDER_DESC_PATH variables as shown in the expandable.

 

OSActionVariableLocationDescriptionExample
LinuxSet

MAYA_RENDER_DESC_PATH

Anchor
1.3.1.3
1.3.1.3

2.2.2.2VRAY_FOR_MAYAnnnn_PLUGINS 1.7

<unpacked_zip_location>/maya_
vray
root/bin/
vraypluginsLoads the V-Ray plugins
rendererDescNeeded to run batch rendering with Maya.export
VRAY
MAYA_
FOR
RENDER_
MAYA2020
DESC_
PLUGINS
PATH=/opt/vray_builds/vray_51020_maya2020/maya_
vray
root/bin/
vrayplugins
rendererDesc
macOS
Linux
Set
Extend
VRAY_PLUGINS 2.2

LD_LIBRARY_PATH

<unpacked_zip_location>/maya_
vray
root/
vraypluginsNeeded for
libRequired to run V-Ray
Standalone. Anchor1.8.1.8
itself.export LD_LIBRARY_PATH=/opt
1.8.1.8export VRAY_PLUGINS=
/vray_builds/vray_51020_maya2020/maya_
vray/vrayplugins
root/lib:$LD_LIBRARY_PATH
export VRAY_OSL_PATH_MAYA2020=
Tabs Page
titlemacOS
macOSSetVRAY_OSL_PATH_MAYAnnnn 1.8<unpacked_zip_location>/vray/openslLoads OSL plugins for V-Ray.
Tabs Page
titleLinux
UI Text Box
typeinfo

The example directory and version names below are for V-Ray 5 for Maya 2020 on macOS where vray_adv_51020_maya2020_mavericks_x64.zip has been unpacked into 

/vray_builds/vray_51020_maya2020/

vray/opensl

.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

UI Text Box
typenote

V-Ray 5, update 1 introduces changes to the DYLD_LIBRARY_PATH and MAYA_RENDER_DESC_PATH environment variables.

For macOS, DYLD_LIBRARY_PATH should no longer be set for V-Ray for Maya and should only be set when running V-Ray Standalone.

To set up the environment for V-Ray 5, see the setup for older versions of V-Ray.

OSActionVariableLocationDescriptionExample
macOSSet

MAYA_RENDER_DESC_PATH

Anchor
1.6.1.6
1.6.1.6

macOSExtendMAYA_PLUG_IN_PATH<unpacked_zip_location>/maya_vray/plug-insLoads the V-Ray for Maya main plugins.export MAYA_PLUG_IN_PATH=/vray_builds/vray_51020_maya2020/maya_vray/plug-ins:$MAYA_PLUG_IN_PATHmacOSExtendMAYA_SCRIPT_PATH <unpacked_zip_location>/maya_vray/scriptsLoads the V-Ray for Maya scripts.export MAYA_SCRIPT_PATH=/vray_builds/vray_51020_maya2020/maya_vray/scripts:$MAYA_SCRIPT_PATHmacOSExtendMAYA_PRESET_PATH

<unpacked_zip_location>/maya_vray/
presets
rendererDescNeeded to run batch rendering with Maya
Loads the V-Ray material presets
.export MAYA_RENDER_
PRESET
DESC_PATH=/vray_builds/vray_51020_maya2020/maya_vray/
presets:$MAYA_PRESET_PATH
rendererDesc
macOS
Extend
SetVRAY_FOR_MAYAnnnn_MAIN1.6
PYTHONPATH

<unpacked_zip_location>/maya_vray

/scripts

Anchor
1.7.1.7
1.7.1.7

Loads the V-Ray
python scripts
for Maya plugins.export
PYTHONPATH
VRAY_FOR_MAYA2020_MAIN=/vray_builds/vray_51020_maya2020/maya_vray
/scripts:$PYTHONPATH
macOS
Extend
Set
XBMLANGPATH

Anchor

3

2.2.

3

2.2

3

2.2.

3

2.2
VRAY_FOR_MAYAnnnn_PLUGINS 1.7

<unpacked_zip_location>/maya_vray/
icons
vrayplugins

Loads the V-Ray

icons

plugins.

export
XBMLANGPATH
VRAY_FOR_MAYA2020_PLUGINS=/vray_builds/vray_51020_maya2020/maya_vray/
icons:$XBMLANGPATH
vrayplugins
macOSSetVRAY_
AUTH_CLIENT_FILE_PATH 3.2arbitrary locationPoints V-Ray to a V-Ray license.export VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>macOSExtend

MAYA_CUSTOM_TEMPLATE_PATH

PLUGINS 2.2
<unpacked_zip_location>/maya_vray/
scriptsLoads the node editor and lookdev templates.
vrayplugins

Needed for V-Ray Standalone.

Anchor
1.8.1.8
1.8.1.8

export VRAY_PLUGINS
export MAYA_CUSTOM_TEMPLATE_PATH
=/vray_builds/vray_51020_maya2020/maya_vray/
scripts:$MAYA_CUSTOM_TEMPLATE_PATH
vrayplugins
macOSSet
MAYA
VRAY_
TOOLCLIPS
OSL_PATH_MAYAnnnn 1.8<unpacked_zip_location>
\maya_vray\toolclips
/vray/openslLoads OSL plugins
Enables toolclips
for V-Ray.export
MAYA
VRAY_
TOOLCLIPS
OSL_PATH_MAYA2020=/vray_builds/vray_51020_maya2020/
maya_
vray/
toolclips:$MAYA_TOOLCLIPS_PATH
opensl
macOSExtendMAYA_PLUG_IN_PATH<unpacked_zip_location>/maya_vray/plug-insLoads the V-Ray for Maya main plugins.export MAYA_PLUG_IN_PATH=/vray_builds/vray_51020_maya2020/maya_vray/plug-ins:$MAYA_PLUG_IN_PATH
macOSExtendMAYA_SCRIPT_PATH

 

 

AnchorenvSetupV5OSXenvSetupV5OSX
UI Expand
titleExpand to see the setup...
For older V-Ray versions, use the setup for V-Ray 5, update 1 from the table above and change the DYLD_LIBRARY_PATH and MAYA_RENDER_DESC_PATH variables as shown in the expandable.

 

MAYA_RENDER_DESC_PATHroot/Maya.app/Contents/bin/rendererDesc/Needed to run batch rendering with Maya
OSActionVariableLocationDescriptionExample
macOSSet
Anchor
1.6.1.61.6.1.6<unpacked_zip_location>/maya_vray/scriptsLoads the V-Ray for Maya scripts.export MAYA_RENDER_DESCSCRIPT_PATH=/vray_builds/vray_51020_maya2018maya2020/maya_root/bin/rendererDesc vray/scripts:$MAYA_SCRIPT_PATH
macOSExtendDYLDMAYA_LIBRARYPRESET_PATH<unpacked_zip_location>/maya_root/Maya.app/Contents/MacOSvray/presetsLoads the Required to run V-Ray itselfmaterial presets.export DYLDMAYA_LIBRARYPRESET_PATH=/vray_builds/vray_51020_maya2018maya2020/maya_root/Maya.app/Contents/MacOS:$DYLD_LIBRARY_PATH

...

vray/presets:$MAYA_PRESET_PATH
macOSExtendPYTHONPATH<unpacked_zip_location>/maya_vray/scriptsLoads the V-Ray python scripts.export PYTHONPATH=/vray_builds/vray_51020_maya2020/maya_vray/scripts:$PYTHONPATH
macOSExtend

XBMLANGPATH

Anchor
3.2.3.2
3.2.3.2

<unpacked_zip_location>/maya_vray/iconsLoads the V-Ray icons.export XBMLANGPATH=/vray_builds/vray_51020_maya2020/maya_vray/icons:$XBMLANGPATH
macOSSetVRAY_AUTH_CLIENT_FILE_PATH 3.2arbitrary locationPoints V-Ray to a V-Ray license.export VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>
macOSExtend

MAYA_CUSTOM_TEMPLATE_PATH

<unpacked_zip_location>/maya_vray/scriptsLoads the node editor and lookdev templates.export MAYA_CUSTOM_TEMPLATE_PATH=/vray_builds/vray_51020_maya2020/maya_vray/scripts:$MAYA_CUSTOM_TEMPLATE_PATH
macOSSetMAYA_TOOLCLIPS_PATH<unpacked_zip_location>/maya_vray/toolclipsEnables toolclips for V-Ray.

export MAYA_TOOLCLIPS_PATH=/vray_builds/vray_51020_maya2020/maya_vray/toolclips:$MAYA_TOOLCLIPS_PATH

macOSExtend

PXR_PLUGINPATH_NAME

<unpacked_zip_location>/maya_vray/usdplugins

Loads USD plugins for V-Ray.

export PXR_PLUGINPATH_NAME=/vray_builds/vray_51020_maya2020/maya_vray/usdplugins:$PXR_PLUGINPATH_NAME

macOSSet

VRAY_APPSDK_PLUGINS

<unpacked_zip_location>/maya_vray/vrayplugins

Loads V-Ray App SDK plugins.

export VRAY_APPSDK_PLUGINS=/vray_builds/vray_51020_maya2020/maya_vray/vrayplugins

 

Anchor
envSetupV5OSX
envSetupV5OSX

UI Expand
titleExpand to see the setup...
For older V-Ray versions, use the setup for V-Ray 5, update 1 from the table above and change the DYLD_LIBRARY_PATH and MAYA_RENDER_DESC_PATH variables as shown in the expandable.

 

OSActionVariableLocationDescriptionExample
macOSSet

MAYA_RENDER_DESC_PATH

Anchor
1.6.1.6
1.6.1.6

<unpacked_zip_location>/maya_root/Maya.app/Contents/bin/rendererDesc/Needed to run batch rendering with Maya.export MAYA_RENDER_DESC_PATH=/vray_builds/vray_51020_maya2018/maya_root/bin/rendererDesc
macOSExtend

DYLD_LIBRARY_PATH

<unpacked_zip_location>/maya_root/Maya.app/Contents/MacOSRequired to run V-Ray itself.export DYLD_LIBRARY_PATH=/vray_builds/vray_51020_maya2018/maya_root/Maya.app/Contents/MacOS:$DYLD_LIBRARY_PATH

Notes:
Anchor
note_1
note_1

1 (1.1, 1.2, 1.3, 1.4, 1.5, 1.61.71.8) - nnnn is the Maya version. For example, 2020, 2019, 2018, etc.

Anchor
note_2
note_2

2 (2.12.2) - VRAY_PLUGINS is used for running the V-Ray Standalone executable that comes with the V-Ray for Maya installation. This is needed to render .vrscene files directly with V-Ray Standalone. An alternative to setting VRAY_PLUGINS as an environment variable is using the config.xml located in vray_builds/my_version/maya_vray/bin/config.xml. You will need to edit the xml file with a text editor and point the <PluginsPath>/vrayplugins to vray_builds/my_version/maya_vray/vrayplugins.
-- Example: Locate the xml file in the location where the ZIP build is unpacked, in the examples so far -  /opt/vray_builds/vray40401_maya2018/maya_vray/bin/config.xml.
-- Once edited, here's how the line containing the vrayplugins location should look like: <PluginsPath>/opt/vray_builds/vray40401_maya2018/maya_vray/vrayplugins</PluginsPath>

UI Expand
titleExample:config.xml
Tabs Container
directionhorizontal
Tabs Page
titleWindows
Code Block
languagexml
 <!--
	Example contents of config.xml as an alternative to settings the VRAY_PLUGINS environment variable
	In this example, the ZIP installation is for V-Ray 5 for Maya 2020 for Windows and the .zip file is extracted in D:\vray_builds\.
	In this case, the config.xml file is located in D:\vray_builds\vray_51020_maya2020\maya_vray\bin\config.xml.
-->
<VRayStd>
	<Configuration>
		<PluginsPath>D:\vray_builds\vray_51020_maya2020\maya_vray\vrayplugins</PluginsPath>
	</Configuration>
</VRayStd>
Tabs Page
titleLinux
Code Block
languagexml
 <!--
	Example contents of config.xml as an 

...

2 (2.1, 2.2) - VRAY_PLUGINS is used for running the V-Ray Standalone executable that comes with the V-Ray for Maya installation. This is needed to render .vrscene files directly with V-Ray Standalone. An alternative to setting VRAY_PLUGINS as an environment variable is using the config.xml located in vray_builds/my_version/maya_vray/bin/config.xml.xml. You will need to edit the xml file with a text editor and point the [PLUGINS]/vrayplugins to vray_builds/my_version/maya_vray/vrayplugins.
-- Example: Locate the xml file in the location where the ZIP build is unpacked, in the examples so far -  /opt/vray_builds/vray40401_maya2018/maya_vray/bin/config.xml.
-- Once edited, here's how the line containing the vrayplugins location should look like: <PluginsPath>/opt/vray_builds/vray40401_maya2018/maya_vray/vrayplugins</PluginsPath>

UI Expand
titleExample:config.xml
Tabs Container
directionhorizontal
Tabs Page
titleWindows
Code Block
languagexml
 <!--
	Example contents of config.xml.xml as an alternative to settings the VRAY_PLUGINS environment variable
	In this example, the ZIP installation is for V-Ray 5 for Maya 2020 for Windows and the .zip file is extracted in D:\vray_builds\.
	In this case, the config.xml file is located in D:\vray_builds\vray_51020_maya2018\maya_vray\bin\config.xml.
-->
<VRayStd>
	<Configuration>
		<PluginsPath>D:\vray_builds\vray_51020_maya2020\maya_vray\vrayplugins</PluginsPath>
	</Configuration>
</VRayStd>
Tabs Page
titleLinux
Code Block
languagexml
 <!-- Example contents of config.xml.xml as an
alternative to settings the VRAY_PLUGINS environment variable
	In this example, the ZIP installation is for V-Ray 5 for Maya 2020 for Linux and the .zip file is extracted in /opt/vray_builds/.
	In this case, the config
.xml
.xml file is located in /opt/vray_builds/vray_51020_
maya2018
maya2020/maya_vray/bin/config.xml.
-->
<VRayStd>
	<Configuration>
		<PluginsPath>/opt/vray_builds/vray_51020_maya2020/maya_vray/vrayplugins</PluginsPath>
	</Configuration>
</VRayStd>
Tabs Page
titlemacOS
Code Block
languagexml
 <!--
	Example contents of config
.xml
.xml as an alternative to settings the VRAY_PLUGINS environment variable
	In this example, the ZIP installation is for V-Ray 5 for Maya 2020 for macOS and the .zip file is extracted in the root of the system drive in a new folder called vray_builds.
	In this case, the config.xml file is located in /vray_builds/vray_51020_maya2020/maya_vray/bin/config.xml.
-->
<VRayStd>
	<Configuration>
		<PluginsPath>/vray_builds/vray_51020_
maya2018
maya2020/maya_vray/vrayplugins</PluginsPath>
	</Configuration>
</VRayStd>

...

Anchor
note_3
note_3

3 (3.1, 3.2) - VRAY_AUTH_CLIENT_FILE_PATH needs to point to the folder that contains

...

the vrlclient.

...

xml  file that holds the V-Ray license server settings (IP address and port number). Alternatively, using the tool to set or change your license settings

...

 will create

...

the vrlclient.

...

xml file for you at a default location and there will be no need to explicitly define its location the VRAY_AUTH_CLIENT_FILE_PATH

...

 variable. However, it might be useful to use the variable to define per-user license settings.
For the case where using the environment variable is the best option for you and you need to create

...

the vrlclient.

...

xml file manually,

...

the example below shows what it

...

should contain:

UI Expand
titleExample: vrlclient.xml
Code Block
languagexml
 <!--
	Example contents of vrlclient.xml
	In this example, the primary IP address to look for a valid license is 10.0.0.100 at the default 30304 port.
	Alternate servers (hosts) have not been set.
-->
<VRLClient>
	<LicServer>
		<Host>10.0.0.100</Host>
		<Port>30304</Port>
		<Host1></Host1>
		<Port1>30304</Port1>
		<Host2></Host2>
		<Port2>30304</Port2>
		<User></User>
		<Pass></Pass>
	</LicServer>
</VRLClient>

 

You can now run Maya.

 

Here is

...

sample Maya.env  file for V-Ray 5 for Maya 2020 on Windows, where the .zip installation has been extracted

...

to D:\vray_builds\vray_51020_maya2020. Place the file in C:\Users\<username>\Documents\maya\2020 or combine its contents with the already existing Maya.env that you will find there, in case the original file is not empty.

UI Text Box
typenote

Note that declarations of environment variables in Maya.env extend the existing environment variables and do not overwrite them. Clean up any leftover environment variables for V-Ray manually, if using an .env file.

 

Anchor
env_setup_std
env_setup_std

 

Setup for V-Ray

...

Standalone


Environment Variables


The ZIP install can also be used to run only V-Ray Standalone without running V-Ray for Maya. In this case, the number of environment variables to set is reduced.

The list or variables to set requires unpacking the same ZIP build

...

. Read the Unpacking the .zip file section for more details.

 

 

 

Tabs Container
titleEnvironment variables
directionhorizontal
Tabs Page
titleWindows
UI Text Box
typeinfo

The example directory and version names below are for V-Ray 5 for Maya 2020 on Windows where vray_adv_51020_maya2020_x64.zip has been unpacked into D:\vray_builds\vray_51020_maya2020\.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

OSAction

Variable

Anchor
4.4
4.4

LocationDescriptionExample
WindowsSetVRAY_PLUGINS 4<unpacked_zip_location>\maya_vray\vraypluginsNeeded for V-Ray Standalone.set VRAY_PLUGINS=

 

...

Required to run V-Ray itself.Location
Tabs Container
titleEnvironment variables
directionhorizontal
Variable
Tabs Page
titleWindows
UI Text Box
typeinfo
The example directory and version names below are for V-Ray 5 for Maya 2020 on Windows where vray_adv_51020_maya2020_x64.zip has been unpacked into 
D:\vray_builds\vray_51020_maya2020\maya_vray\
.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

OSAction
Anchor
4.44.4LocationDescriptionExampleWindowsSet
vrayplugins
WindowsSetVRAY_OSL_PATH

<unpacked_zip_location>\vray\opensl

Loads OSL plugins for V-Ray.set VRAY_OSL_PATH_MAYA2020=D:\vray_builds\vray_51020_maya2020\vray\opensl
WindowsExtend

PATH

VRAY_PLUGINS 4

<unpacked_zip_location>\
maya_
vray\
vraypluginsNeeded for
lib

Required to run V-Ray

Standalone.set VRAY_PLUGINS

itself.

Anchor
5.5
5.5

set PATH=D:\vray_builds\vray_51020_maya2020\

maya_vray\vrayplugins
WindowsSetVRAY_OSL_PATH

<unpacked_zip_location>\vray\opensl

Loads OSL plugins for V-Ray.set VRAY_OSL_PATH_MAYA2020=D:\vray_builds\vray_51020_maya2020\vray\opensl
WindowsExtend

PATH

<unpacked_zip_location>\vray\lib
Anchor
5.55.5

set PATH=D:\vray_builds\vray_51020_maya2020\vray\lib;%PATH%

WindowsSetVRAY_AUTH_CLIENT_FILE_PATH 5arbitrary locationPoints V-Ray to a V-Ray license.set VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>
Tabs Page
titleLinux

vray\lib;%PATH%

WindowsSetVRAY_AUTH_CLIENT_FILE_PATH 5arbitrary locationPoints V-Ray to a V-Ray license.set VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>
Tabs Page
titleLinux
UI Text Box
typeinfo

The example directory and version names below are for V-Ray 5 for Maya 2020 on Linux where vray_adv_51020_maya2020_linux_x64.zip has been unpacked into /opt/vray_builds/vray_51020_maya2020/.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

OSActionVariable

Location

Anchor
4.1.4.1
4.1.4.1

DescriptionExample
LinuxSet

VRAY_PLUGINS 4.1

<unpacked_zip_location>/maya_vray/vraypluginsNeeded for V-Ray Standalone.export VRAY_PLUGINS=/opt/vray_builds/maya_vray/vray_51020_maya2020/vrayplugins
LinuxSet

VRAY_OSL_PATH

<unpacked_zip_location>/vray/openslLoads OSL plugins for V-Ray.export VRAY_OSL_PATH=
UI Text Box
typeinfo
The example directory and version names below are for V-Ray 5 for Maya 2020 on Linux where vray_adv_51020_maya2020_linux_x64.zip has been unpacked into 
/opt/vray_builds/vray_51020_maya2020/
.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

OSActionVariable
Anchor
4.1.4.14.1.4.1DescriptionExample
vray/opensl
LinuxExtend

LD_LIBRARY_PATH

<unpacked_zip_location>/vray/lib

Anchor
5.1.5.1
5.1.5.1

Required to run V-Ray itself.

export LD_LIBRARY_PATH

LinuxSet

VRAY_PLUGINS 4.1

<unpacked_zip_location>/maya_vray/vraypluginsNeeded for V-Ray Standalone.export VRAY_PLUGINS

=/opt/vray_builds/

maya_

vray

/vray

_51020_maya2020/

vrayplugins

vray/lib:$LD_LIBRARY_PATH

LinuxSetVRAY_AUTH_CLIENT_
OSL
FILE_PATH
<unpacked_zip_location>/vray/opensl
5.1arbitrary locationPoints V-Ray to a
Loads OSL plugins for
V-Ray license.export VRAY_AUTH_CLIENT_
OSL
FILE_PATH=
/opt/vray_builds/vray_51020_maya2020/vray/openslLinuxExtend

LD_LIBRARY_PATH

<unpacked_zip_location>/vray/lib

<folder_containing_vrlclient.xml>
Anchor5.1.5.15.1.5.1Required to run V-Ray itself.export LD_LIBRARY_PATH=/opt
Tabs Page
titlemacOS
Tabs Page
titleLinux
UI Text Box
typeinfo

The example directory and version names below are for V-Ray 5 for Maya 2020 on macOS where vray_adv_51020_maya2020_mavericks_x64.zip has been unpacked into 

/vray_builds/vray_51020_maya2020/

vray/lib:$LD_LIBRARY_PATHLinuxSetVRAY_AUTH_CLIENT_FILE_PATH 5.1arbitrary locationPoints V-Ray to a V-Ray license.export VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml> Tabs Page
titlemacOS
Location

.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

OSActionVariable

Location

Anchor
4.2.4.2
4.2.4.2

DescriptionExample
macOSSetVRAY_PLUGINS 4.2<unpacked_zip_location>/maya_vray/vraypluginsNeeded for V-Ray Standalone.export VRAY_PLUGINS=/vray_builds/vray_51020_maya2020/maya_vray/vrayplugins
macOSSet

VRAY_OSL_PATH

<unpacked_zip_location>/vray/openslLoads OSL plugins for V-Ray.export VRAY_OSL_PATH_MAYA2020=
Tabs Page
titleLinux
UI Text Box
typeinfo
The example directory and version names below are for V-Ray 5 for Maya 2020 on macOS where vray_adv_51020_maya2020_mavericks_x64.zip has been unpacked into 
/vray_builds/vray_51020_maya2020/
.

Here is a list of the environment variables and their description and examples. An example of a complete setup will be given further below.

OSActionVariable
vray/opensl
macOSExtend

DYLD_LIBRARY_PATH

<unpacked_zip_location>/vray/lib

Anchor
5.2.5.2
5.2.5.2

Required to run V-Ray itself.

export DYLD_LIBRARY_PATH

Anchor4.2.4.24.2.4.2DescriptionExamplemacOSSetVRAY_PLUGINS 4.2<unpacked_zip_location>/maya_vray/vraypluginsNeeded for V-Ray Standalone.export VRAY_PLUGINS

=/vray_builds/vray_51020_maya2020

/maya_vray/vraypluginsmacOSSet

VRAY_OSL_PATH

<unpacked_zip_location>/vray/openslLoads OSL plugins for V-Ray.export VRAY_OSL_PATH_MAYA2020=/vray_builds/vray_51020_maya2020/vray/openslmacOSExtend

DYLD_LIBRARY_PATH

<unpacked_zip_location>/vray/lib Anchor5.2.5.25.2.5.2Required to run V-Ray itself.

export DYLD_LIBRARY_PATH=/vray_builds/vray_51020_maya2020/vray/lib:$DYLD_LIBRARY_PATH

macOSSetVRAY_AUTH_CLIENT_FILE_PATH 5.2arbitrary locationPoints V-Ray to a V-Ray license.export VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>

...

/vray/lib:$DYLD_LIBRARY_PATH

macOSSetVRAY_AUTH_CLIENT_FILE_PATH 5.2arbitrary locationPoints V-Ray to a V-Ray license.export VRAY_AUTH_CLIENT_FILE_PATH=<folder_containing_vrlclient.xml>

 

Tags


The [STDROOT] and [PLUGINS] tags in the script are normally replaced with their directories by the V-Ray installer, but when you are using a .zip installation, you need to replace them manually. The [STDROOT] tag needs to be replaced with the full path to the vray folder in the zip file. The [PLUGINS] tag need to be replaced with the full path to the maya_vray folder in the zip. The tags are located in the following files:


Section
Column
width50%

Linux and MacOS:

maya_vray/bin/vray

maya_vray/bin/vrayserver

vray/vray_netinstall_client_setup.sh

vray/samples/appsdk/setenv39.sh

vray/bin/vraymayaserver.conf

vray/bin/registerVRayServerDaemon

vray/bin/initVRayServerDaemon

vray/bin/vraymayaserver.service

maya_vray/bin/plgparams

Column
width50%

Windows:

maya_vray/bin/plgparams




Anchor
std_note_1
std_note_1

4 (4.1,

...

 4.2) - VRAY_PLUGINS is used for running the V-Ray Standalone executable that comes with the V-Ray for Maya installation. This is needed to render .vrscene files directly with V-Ray Standalone. An 

...

alternative to setting VRAY_PLUGINS as an environment variable is using the config.xml

...

located in vray_builds/my_version/maya_vray/bin/config

...

.xml. You will need to edit the xml file with a text editor and point the [PLUGINS]/vrayplugins to vray_builds/my_version/maya_vray/vrayplugins.
-- Example: Locate the xml file in the location where the ZIP build is unpacked, in the examples so far -  /opt/vray_builds/vray_51020_maya2020/maya_vray/bin/config.xml.
-- Once edited, here's how the line containing the vrayplugins location should look like:

...

 <PluginsPath>/opt/vray_builds/vray_51020_maya2020/maya_vray/vrayplugins</PluginsPath>


UI Expand
titleExample: config.xml
Tabs Container
directionhorizontal
Tabs Page
titleWindows
Code Block
languagexml
 <!--
	Example contents of config.xml
.xml
 as an alternative to settings the VRAY_PLUGINS environment variable
	In this example, the ZIP installation is for V-Ray 5 for Maya 2020 for Linux and the .zip file is extracted in D:\vray_builds\.
	In this case, the config.xml file is located in D:\vray_builds\vray_51020_maya2020\maya_vray\bin\config.xml.
-->
<VRayStd>
	<Configuration>
		<PluginsPath>D:\vray_builds\vray_51020_maya2020\maya_vray\vrayplugins</PluginsPath>
	</Configuration>
</VRayStd>
Tabs Page
titleLinux
Code Block
languagexml
 <!--
	Example contents of config.xml
.xml
 as an alternative to settings the VRAY_PLUGINS environment variable
	In this example, the ZIP installation is for V-Ray 5 for Maya 2020 for Linux and the .zip file is extracted in /opt/vray_builds/.
	In this case, the config.xml file is located in /opt/vray_builds/vray_51020_maya2020/maya_vray/bin/config.xml.
-->
<VRayStd>
	<Configuration>
		<PluginsPath>/opt/vray_builds/vray_51020_maya2020/maya_vray/vrayplugins</PluginsPath>
	</Configuration>
</VRayStd>
Tabs Page
titlemacOS
Code Block
languagexml
 <!--
	Example contents of config
.xml
.xml as an alternative to settings the VRAY_PLUGINS environment variable
	In this example, the ZIP installation is for V-Ray 5 for Maya 2020 for macOS and the .zip file is extracted in the root of the system drive in a new folder called vray_builds.
	In this case, the config.xml
.xml
 file is located in /vray_builds/vray_51020_maya2020/maya_vray/bin/config.xml.
xml.

-->
<VRayStd>
	<Configuration>
		<PluginsPath>/vray_builds/vray_51020_maya2020/maya_vray/vrayplugins</PluginsPath>
	</Configuration>
</VRayStd>

...

Anchor
std_note_2
std_note_2

5 (5.1,

...

 5.2)  - VRAY_AUTH_CLIENT_FILE_PATH needs to point to the folder that contains

...

the vrlclient.xml  file that holds the V-Ray license server settings (IP address and port number). Alternatively, using

...

the tool to set or change your license

...

settings will create the vrlclient.xml file for you at a default location and there will be no need to explicitly define its location the VRAY_AUTH_CLIENT_FILE_

...

PATH variable. However, it might be useful to use the variable to define per-user license settings.
For the case where using the environment variable is the best option for you and you need to create the vrlclient.xml file manually,

...

the example below shows what it

...

s hould contain:

UI Expand
titleExample: vrlclient.xml
Code Block
languagexml
 <!--
	Example contents of vrlclient.xml
	In this example, the primary IP address to look for a valid license is 10.0.0.100 at the default 30304 port.
	Alternate servers (hosts) have not been set.
-->
<VRLClient>
	<LicServer>
		<Host>10.0.0.100</Host>
		<Port>30304</Port>
		<Host1></Host1>
		<Port1>30304</Port1>
		<Host2></Host2>
		<Port2>30304</Port2>
		<User></User>
		<Pass></Pass>
	</LicServer>
</VRLClient>

...

If you want to use any additional tools like the Irradiance map viewer, the VRIMG to OpenEXR converter etc., then also add to the 

...

PATH environment variable vray_builds/my_version/vray/bin.

UI Text Box

Please note that by default the V-Ray installer will set the TdrLevel (that is GPU timeout detection and recovery) to 0 (disabled).