Multiverse

# Windows Installation

# Installing from the ZIP archive

As of version 7 we are providing a "flat" installer from a .zip package for both the PRO versions (offline and cloud).

  1. Download from the J Cube website your Multiverse package, it will be named something like:

    Multiverse-<version>-<python-<UUID>-<CLOUD|PRO>-Windows.zip

  2. Unzip to your desired location, feel free to change the folder name to your convenience, for example this could be in:

    C:\Program Files\Multiverse\8.0.0\ (local to your machine) X:\software\Multiverse\8.0.0\ (on your network)

    The location and folder name is entirely up to you.

# Loading the plugin

It is time to run Maya and load the plugin.

You have three options to have Maya find and load the Multiverse plug-in, choose the one you are more comfortable with:

  • Option 1: run maya.exe from a Windows Command Prompt (cmd) after executing, within the same command prompt, the multiverse-cmd.bat script that is provided in the installation folder.

  • Option 2: add to the MAYA_MODULE_PATH environment variable the exact path to the Multiverse installation folder. Then run Maya in any way you like (e.g. from the Start menu or Maya icon, or from the command prompt...)

  • Option 3: add to the MAYA_MODULE_PATH environment variable in Maya.env the exact path to the Multiverse installation folder, then run Maya in any way you like (e.g. from the Start menu, Maya icon, command prompt...)

We will present each option in detail here below.

# Option 1: Execute environment script and launch Maya from the Command Prompt

Run Maya under the environment provided:

  • open a cmd
  • go to the installation folder, e.g:
cd "C:\Program Files\Multiverse\8.0.0\"
1
  • execute multiverse-cmd.bat to setup the environment
  • launch Maya by executing, e.g:
"c:\Program Files\Autodesk\Maya20XY\bin\maya.exe"
1

  • once Maya has launched, go to the plugin manager and you will find the "MultiverseForMaya" plugin:

Note

Multiverse supports multiple rendering engines and you will see other plugins listed with the MultiverseForMaya plugin:

  • Support for Arnold is built-in with the MultiverseForMaya plug-in (being Arnold part of Maya).
  • Support for 3Delight, Renderman and VRay is provided by individual plug-ins extensions which will be automatically loaded for the rendering plugins you have loaded in Maya.
  • Support for Redshift is handled automatically: Redshift handles loading of the Multiverse rendering extension without the need for a dedicated Maya plug-in, hence why there is no Multiverse Redshift plug-in visible in the plug-in manager.

The bottom line is that you don't need to load the other plugins, they will load automatically if the relative renderer is loaded, regardless of the loading order.

If you don't have a license the plug-in will not load (and notify you with a pop up), so make sure you have a license for either the PRO version (offline or cloud):

Heads Up!

Remember that if you are running the PRO CLOUD versions you need to be connected to the internet.

After loading the plug-in, you should be able to see the Multiverse Shelf in Maya. Learn more about the Multiverse Shelf and other UI in Maya.

# Option 2: set MAYA_MODULE_PATH environment variable and launch Maya

  • Set the environment variable MAYA_MODULE_PATH to the path location where the MultiverseForMaya.mod file is located inside the Multiverse installation chosen before.

    You can do this by clicking The Windows Start and typing "Edit the Environment Variables for your account", then add the following user or system environment variable (if you have permissions):

    MAYA_MODULE_PATH = %MAYA_MODULE_PATH%;C:\Program Files\Multiverse\8.0.0\Maya
    1

  • Launch Maya in whichever way you like (start menu, desktop icon, cmd...)

  • Load the MultiverseForMaya plugin as explained in Option 1.

  • You should now see the Multiverse Shelf as before.

# Option 3: Set MAYA_MODULE_PATH in Maya.env and launch Maya

Similarly to Option 2, locate your Maya.env file and then add the MAYA_MODULE_PATH and set its value accordingly.

FYI Maya.env is located / found in:

  • Windows: drive:\Users\username\Documents\maya\version
  • MacOS: /Users/username/Library/Preferences/Autodesk/maya/version or /Users/username/Library/Preferences/Autodesk/maya
  • Linux: ~/maya/version or ~/maya

# Understand the Multiverse environment

For more complex installations, custom pipeline application launchers or when needing to use render with a command line renderer, it is best to have a clear understanding of the Multiverse environment.

Check the contents of the included multiverse-cmd.bat script file:

@echo off

REM %~dp0 expands to the drive letter and path of this very batch file
SET MV_ROOT=%~dp0

SET MAYA_MODULE_PATH=%MV_ROOT%Maya;%MAYA_MODULE_PATH%
SET PATH=%MV_ROOT%bin;%MV_ROOT%lib;%PATH%
SET PYTHONPATH=%MV_ROOT%lib\python;%PYTHONPATH%
SET USD_PLUG_IN_PATH=%MV_ROOT%plugin\usd

REM PATH=%PATH%;<path to desired maya version python shared library>

REM Used by Maya to Arnold and Arnold standalone
SET ARNOLD_PLUGIN_PATH=%MV_ROOT%lib\procedurals\arnold;%ARNOLD_PLUGIN_PATH%

REM Used by VRay standalone
SET VRAY_PLUGINS=%MV_ROOT%lib\procedurals\vray;%VRAY_PLUGINS%

REM Used by VRay for Maya
SET VRAY_FOR_MAYA2018_PLUGINS=%MV_ROOT%lib\procedurals\vray;%VRAY_FOR_MAYA2018_PLUGINS%
SET VRAY_FOR_MAYA2019_PLUGINS=%MV_ROOT%lib\procedurals\vray;%VRAY_FOR_MAYA2019_PLUGINS%
SET VRAY_FOR_MAYA2020_PLUGINS=%MV_ROOT%lib\procedurals\vray;%VRAY_FOR_MAYA2020_PLUGINS%
SET VRAY_FOR_MAYA2022_PLUGINS=%MV_ROOT%lib\procedurals\vray;%VRAY_FOR_MAYA2022_PLUGINS%
SET VRAY_FOR_MAYA2023_PLUGINS=%MV_ROOT%lib\procedurals\vray;%VRAY_FOR_MAYA2023_PLUGINS%
SET VRAY_FOR_MAYA2024_PLUGINS=%MV_ROOT%lib\procedurals\vray;%VRAY_FOR_MAYA2024_PLUGINS%

REM Used by Renderman for Maya
SET RFM_PLUGINS_PATH=%MV_ROOT%lib\procedurals\renderman;%RFM_PLUGINS_PATH%

REM NOTE: As of 3Delight NSI no search path is needed for procedurals

ECHO Multiverse Environment is set
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# Convenience alias for Maya on Windows

Finally from the a cmd where the above environment was set, you can run Maya. You can set some Command Prompt aliases via the DOSKEY batch command to avoid typing the full path, for example:

DOSKEY maya18="C:\Program Files\Autodesk\Maya2018\bin\maya.exe"
DOSKEY maya19="C:\Program Files\Autodesk\Maya2019\bin\maya.exe"
DOSKEY maya20="C:\Program Files\Autodesk\Maya2020\bin\maya.exe"
DOSKEY maya22py27="C:\Program Files\Autodesk\Maya2022\bin\maya.exe -pythonver 2"
DOSKEY maya22="C:\Program Files\Autodesk\Maya2022\bin\maya.exe"
DOSKEY mayapy18="C:\Program Files\Autodesk\Maya2018\bin\mayapy.exe"
DOSKEY mayapy19="C:\Program Files\Autodesk\Maya2019\bin\mayapy.exe"
DOSKEY mayapy20="C:\Program Files\Autodesk\Maya2020\bin\mayapy.exe"
DOSKEY mayapy22py27="C:\Program Files\Autodesk\Maya2022\bin\mayapy2.exe"
DOSKEY mayapy22="C:\Program Files\Autodesk\Maya2022\bin\mayapy.exe"
DOSKEY mayapy23="C:\Program Files\Autodesk\Maya2023\bin\mayapy.exe"
DOSKEY mayapy24="C:\Program Files\Autodesk\Maya2024\bin\mayapy.exe"
1
2
3
4
5
6
7
8
9
10
11
12

# Environment Variables

Read more about Environment Variables.

# Compatibility

Supported Versions
Windows Windows 7, 10
Maya 2018, 2019, 2020, 2022 (python 2.7)
Maya 2022 (python 3.7)
Maya 2023 (python 3.9)
Maya 2024 (python 3.10)
3DelightNSI 2.0.0+
3DelightNSI Cloud Any version
Arnold 5.2.2.1+ (MtoA 3.1.2.1+)
5.3.0.1+ (MtoA 3.2.0+)
5.4.0.0+ (MtoA 3.3.0+)
6.0.1.0+ (MtoA 4.0.1+)
6.1.0.0+ (MtoA 4.1.0+)
6.2.0.0+ (MtoA 4.2.0+)
7.0.0.0+ (MtoA 5.0.0+)
7.1.0.0+ (MtoA 5.1.0+)
7.2.0.0+ (MtoA 5.2.0+)
7.3.0.0+ (MtoA 5.3.2.1+)
RenderMan 23.2+
24.0+
VRay 4.30.01+
5.20.23+
6.00.2+
Redshift 3.0.67+
3.5.03+ (API 3500)
3.5.09+ (API 3501)
3.5.11+ (API 3502)
3.9.19+ (API 3503)

# OpenGL on Windows

Multiverse leverages on Hydra to draw into the Maya Viewport 2.0, and Hydra requires OpenGL. In Maya, on Windows, Viewport 2.0 must be set to an OpenGL mode in Window > Settings/Preferences > Preferences> Display:

Maya VP2 Supported
OpenGL Yes
OpenGL Core Profile Yes (OpenGL 2.1 and OpenGL 3.2)
OpenGL Core Profile (Strict) Yes (OpenGL 3.2)
DirectX Yes (as of Multiverse 7.0.0)

# Remote Desktop

If you are running Maya under a remote desktop session, and you have a nVidia graphics card, setting the the Maya VP2 mode to OpenGL in the Maya preferences is not sufficient because Maya will still try by default run under DirectX and therefore Multiverse will produce a current drawing API isn't supported error.

To workaround this you must do two things:

  1. Install this tool: https://developer.nvidia.com/designworks

  2. Set an environment variable to force the OpenGL mode:

MAYA_ALLOW_OPENGL_REMOTE_SESSION=1
1

NOTE

This variable is working only for the following Maya versions: Maya 2020.0+, Maya 2019.3.1+, Maya 2018.7+, and you must have a nVidia graphic card with at lease driver v440 installed (along with the aforementioned tool).

# Internet Requirements

If you are using the Pro Cloud Version of Multiverse, your computer must be connected to the internet.

Firewalls & Proxies

If needed, make sure that your firewall allows Maya to connect to the internet.

If you are using the Pro Cloud Version within a studio network, and your studio uses the Windows Proxy system, you have to setup the http_proxy and https_proxy environment variables with your windows domain user name and password to let Maya communicate with our servers and checkout your license (ask your Windows system administrator in case). The Multiverse Cloud uses the standard ports 80 (http), 443 (https).

Last Updated: 3/14/2024, 8:32:54 AM

← macOS installation →