This page describes how to set up your local system so that it loads the files for the correct version. The notes here are for the Windows, Linux, and MAC OS X operating systems.

 

Page Contents


Overview


Installing V-Ray for Maya from a .zip file provides several advantages:

  • If you run the normal installation multiple times, environment variables will be overwritten even if you use different Maya installations. Using the ZIP installation gives you the option to set custom environment variables when starting each Maya instance.
  • The ZIP installation can be extracted to 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 such an installation is a lot easier too, as you don't need to run the installer on every user's computer.
  • Sometimes users need to be able to quickly switch between different V-Ray versions without having to constantly reinstall it. In this case, you can use the ZIP file to install and run both V-Ray for Maya and V-Ray Standalone from arbitrary locations on your machine or local network.

 

Unpacking the Contents of the .zip File


Extract the contents of the relevant .zip file into a suitable folder, for example, vray_builds/my_version. After the extraction, there should be three subfolders in it: maya_root, maya_vray, and vray.

 

Setup for Maya


Before you run Maya, you need to perform the following steps:

  1. If you plan to use batch rendering, set the environment variable MAYA_RENDER_DESC_PATH to the folder vray_builds/my_version/maya_root/bin/rendererDesc.
     

  2. Set the VRAY_FOR_MAYAnnnn_MAIN_x64 environment variable to point to the vray_builds/my_version/maya_vray folder where nnnn is the Maya version (2018, 2017, etc. Note that the environment variable name for Maya 2016.5 will be VRAY_FOR_MAYA2016_5_MAIN_x64).
     

  3. Set the VRAY_FOR_MAYAnnnn_PLUGINS_x64 environment variable to point to the folder vray_builds/my_version/maya_vray/vrayplugins.

     Out-of-process IPR

    Should you need to use out-of-process IPR, although it is highly unlikely, you will need to set the VRAY_PLUGINS_x64 environment variable to the folder vray_builds/my_version/maya_vray/vraypluginsAlternatively, you can edit vray_builds/my_version/maya_vray/bin/vrayconfig.xml and set [PLUGINS]/vrayplugins to be vray_builds/my_version/maya_vray/vrayplugins.

  4. Set the VRAY_AUTH_CLIENT_FILE_PATH environment variable to point to the folder that contains the vrlclient.xml file with 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 with an environment variable. Using the VRAY_AUTH_CLIENT_FILE_PATH variable, however, is useful to set per-user license settings and also when V-Ray is started with a script that defines this entire environment setup.

    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: 

    Example: vrlclient.xml
    <!--
    	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>
  5. Set the VRAY_OSL_PATH_MAYAnnnn_x64 environment variable to point to the folder vray_builds/my_version/vray/opensl (if the particular V-Ray version supports OSL).
     

  6. Add paths to path variables based on the OS:

    • On Linux, add to the LD_LIBRARY_PATH environment variable the path to the vray_builds/my_version/maya_root/lib folder.
    • On Windows, add to the PATH environment variable the path to the vray_builds/my_version/maya_root/bin folder.

    • On OSX, add to the DYLD_LIBRARY_PATH environment variable the path to the vray_builds/my_version/maya_root/Maya.app/Contents/MacOS folder.

  7. Add to the MAYA_PLUG_IN_PATH variable the folder vray_builds/my_version/maya_vray/plug-ins. 


  8. Add to the MAYA_SCRIPT_PATH variable the folder vray_builds/my_version/maya_vray/scripts.
     

  9. Add to the PYTHONPATH variable the folder vray_builds/my_version/maya_vray/scripts to be able to use V-Ray's python modules.
     

  10. Add to the XBMLANGPATH variable the folder vray_builds/my_version/maya_vray/icons/.

    Linux specific

     The syntax is slightly different for Linux: %B must be added at the end, for example, vray_builds/my_version/maya_vray/icons/%B

  11. You can now run Maya.

 

Here is a sample Maya.env file for Maya 2018 on Windows, where the .zip installation has been extracted to D:\vray_builds\vray_adv_36001_maya2018_x64. Place the file in C:\Users\<username>\Documents\maya\2018 or combine its contents with the already existing Maya.env that you will find there, in case the original file is not empty.

 

Setup for XGen


If you want to use the VRScene mode for XGen for Maya 2014.5+ there are a few more steps. These steps are NOT required for direct rendering of XGen in Maya 2015+.

  1. Create a config.txt file with a path to the vray_builds/my_version/maya_root/plug-ins/xgen/presets/ by using this text in the file:

    LocalRepo D:/vray_builds/vray_adv_36001_maya2018_x64/maya_root/plug-ins/xgen/presets/
  2. Set the XGEN_CONFIG_PATH environment variable to point to the folder that contains the config.txt file.

 

Setup for V-Ray Standalone


Before running V-Ray Standalone, you need to perform the following steps:

  1. Add paths to path variables based on the OS:

    • On Linux, add to the LD_LIBRARY_PATH environment variable the folder vray_builds/my_version/vray/lib/linux_x64/gcc-4.4.
    • On Windows, add to the PATH environment variable the folder vray_builds/my_version/maya_vray/bin. This is required for running V-Ray itself.

    • On OSX, add to the DYLD_LIBRARY_PATH environment variable the path to the vray_builds/my_version/vray/lib/mavericks_x64/gcc-4.2-cpp (Note that depending on the Maya version, some of the folders may have different names. It's best to check the extracted folder in advance, since, for example, Maya 2015 will require a path like vray_builds/my_version/vray/lib/mountain_lion_x64/gcc-4.2).

  2. 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.

  3. Set the VRAY_PLUGINS_x64 environment variable to the folder vray_builds/my_version/maya_vray/vrayplugins. Alternatively, you can edit vray_builds/my_version/maya_vray/bin/vrayconfig.xml and set [PLUGINS]/vrayplugins to be vray_builds/my_version/maya_vray/vrayplugins.
     

  4. Set the VRAY_OSL_PATH _x64 environment variable to point to the folder vray_builds/my_version/vray/opensl.
     

  5. Set the VRAY_AUTH_CLIENT_FILE_PATH environment variable to point to the folder that contains the vrlclient.xml file with 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 with an environment variable. Using the VRAY_AUTH_CLIENT_FILE_PATH variable, however, is useful to set per-user license settings and also when V-Ray is started with a script that defines this entire environment setup.

    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:

    Example: vrlclient.xml
    <!--
    	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>
  6. You can now run the vray command.