MARUI Setup – Installing, Loading, Starting and Stopping MARUI

This article guides you through the installation, loading, starting, stopping, un-loading and un-installing MARUI.

Download

You can always download the latest version of MARUI at https://www.marui-plugin.com/download/ .
Please use the username (subscriber ID) and password (license key) provided to you when you purchased MARUI.
You will received them via email sent to the account associated with your PayPal account. (The sender address will be contact@marui-plugin.com)
On some occasions, the email is accidentally identified as SPAM by your SPAM filter. If you did not receive the email, please check your “SPAM” folder.
If you have lost your username and password, please contact us at support@marui-plugin.com

Installation

If you downloaded MARUI from the main website (www.marui-plugin.com), no installation is required. Just place the MARUI Plug-in (.mll) file where you like on your hard drive.

For convenience, we recommend placing it in a folder that is part of Maya’s plug-in search path.
By default, this could be C:\Users\<your name>\Documents\maya\<maya version>\plugins,
or you could edit your Maya environment file (usually C:\Users\<your name>\Documents\maya\<maya version>\Maya.env) and add the line:

MAYA_PLUG_IN_PATH = C:\path\to\MARUI

If you downloaded MARUI from the Autodesk Apps Store, an installer will be provided that automatically places the appropriate MARUI files in the default Maya plugin folder (usually %ProgramData%\Autodesk\ApplicationPlugins )

Loading

Start Maya and open the Maya Plug-in Manager (Window > Settings/Preferences > Plug-In Manager) and check the “Loaded” checkbox next to MARUI. If MARUI is not in the list, use the “Browse” button at the bottom of the Plug-In Manager to locate your MARUI PlugIn file.

If you are unable to load MARUI, please make sure that you have the proper MARUI Plug-In file for your version of Maya selected.
Note that Maya2016 and Maya2016Extension2 (sometimes called Maya2016EXT2 or Maya2016.5) have different Plug-In files.
MayaLT versions are not able to use plug-ins, so MARUI cannot be used with MayaLT.

You can use Maya’s “Auto Load” function (the checkbox in the Plug-in Manager window) to make Maya load MARUI automatically on start-up.

Upon loading MARUI, the following error message may appear:

If a shelf with the name “MARUI” already exists, then MARUI will ask you wether you want to overwrite this shelf or if MARUI should use a different shelf name.
This is a safety feature intended to protect scripts you have placed in your shelf.
It can happen that Maya does not correctly remove the MARUI shelf when shutting down. Then it is best to overwrite the old shelf tab.
However, if you are using a shelf tab called “MARUI” for your own scripts, please choose Create separate shelf tab.

Licensing and Activating MARUI

When you load MARUI for the first time, the “MARUI” shelf tab will contain a Licensing button.

Please press the button to open the MARUI license manager.

Please use the user name (subscriber ID) that you received via email when you purchased MARUI.
If you lost your username and password, please contact us at support@marui-plugin.com

Starting MARUI

When MARUI is loaded, a shelf tab named “MARUI” will be available on the Maya shelf.
Start MARUI by opening the MARUI Shelf-Tab and clicking the MARUI Icon.

A “Wizard” type dialog will open with some basic information on MARUI and a “Start” button.

Depending on whether you have additional devices such as Leap Motion or OvrVision stereo cameras available on your PC, the wizard will offer you to use these when starting MARUI.

You can also select to run a tutorial when starting MARUI. If this is your first time to start MARUI we highly recommend the you complete the tutorials. Note that the tutorials will open a new Maya scene, so be sure to save your work before starting a MARUI tutorial.

After you click the “Start” button, a new window will open (this may take a few seconds).
This window will show the virtual scene that you can see when looking through the HMD.

Troubleshooting

Here is a list of common problems that can occur when you try to start MARUI.

The MARUI Wizard has no “Start” button

If the wizard has no “Start” button, but instead displays the error message “ERROR: Could not detect VR device. Make sure you have the appropriate device drivers / runtime installed.”, MARUI was unable to detect any VR device on your computer.
Please go to https://www.oculus.com/setup/ (for Oculus Rift) or http://store.steampowered.com/about (for Steam VR), download and install the required software, and ensure that the device is connected properly to your computer.
In order to use Windows MR headsets, make sure you have Steam installed and Start Steam, go to ‘Library’ -> ‘Software’ and install ‘Windows Mixed Reality for SteamVR’.

The screen in the head-set is black or dark-grey (HTC Vive)

There is a connection problem or software problem in your VR device.
Please make sure that you have the latest VR software for your device installed and running
(available at https://www.oculus.com/setup/ for Oculus Rift or http://store.steampowered.com/about for Steam VR).
Also make sure that your graphics card driver is up-to date.
Finally, please check all cable connections in your VR set-up.
You can check whether your VR set-up is working correctly by running the “VR Tutorial” in the SteamVR menu or Oculus software.

I see a virtual environment (sky and clouds) but not my Maya scene

MARUI has “misplaced” your Maya scene.
MARUI tries to automatically place the Maya scene in front of you when you start, but sometimes this fails.
After starting MARUI, please press the “Reset view to accommodate all objects” button on the shelf.

Then the scene should appear in front of you and be visible in the MARUI desktop window.

Stopping

While MARUI is running (i.e.: the MARUI window is open), you can stop it in either of three ways:

Option A:
Close the MARUI window by clicking on the window close icon.

Option B:
Click the “Stop” button in the MARUI shelf tab:

Option C:
Run the MEL command:
MARUI_Stop()

Unloading

You can unload MARUI from Maya in either of three ways:

Option A:
Click the “Exit” icon on the MARUI shelf:

Option B:
Open the Maya Plug-In Manager (Window > Settings/Preferences > Plug-In Manager) and uncheck the “Loaded” checkbox for MARUI.

Option C:
Run the command:
MARUI_Unload()

When unloading MARUI, the “MARUI” shelf tab will be automatically be removed from the Maya shelf.

Uninstall

If you have downloaded MARUI directly from the MARUI website (www.marui-plugin.com), no un-installation is required.
You can just delete the MARUI plugin file.

If you downloaded MARUI from the Autodesk Apps Exchange as an installer, please remove MARUI via the Windows Control Panel:
Open the Windows StartMenu and select “Control Panel”. Open the “Programs” by clicking “Uninstall a program”, select MARUI from the list, right-click on it and select “Uninstall”.

MARUI may have created a settings file named MARUI_VR_settings.mel and a license file named MARUI_License.mel in your Maya preferences folder.
By default, this is at C:\Users\<your name>\Documents\maya\<maya version>\prefs.
You can delete these files if you no longer need your settings or license information.

Cancelling your subscription

You can cancel your subscription at any time through your PayPal account.
Log in to your PayPal account, and click on the “Settings” button:

On the Settings page, select the “Payments” tab, and click on the “Manage automatic payments” button.

Select “株式会社MARUI-PlugIn” from the list and click on the “cancel” button.

Your subscription will be canceled immediately and you will not be charged any further payments.
You can still use MARUI until the end of the current subscription term, which will be one month after your last payment.