Environment Variables for VRED

Here is a list of the VRED-specific and external environment variables and explanations and/or values for them in VRED.

Where To Enter Environment Variables (Beginners)

If this is the first time setting an environment variable, here is where to do it on Windows. For Mac, see How to Set an Environment Variable on Mac.

  1. Right-click your This PC icon and select Properties.

  2. Click Advanced system settings.

  3. Click the Advanced tab, then the Environment Variables button.

  4. In the System variables section (at the bottom), click New. This open the New System Variable dialog.

  5. Enter the environment variable name and a value, then click OK.

VRED-specific Variables

These environment variables are VRED-specific.

VRED-specific Variable

Value/Explanation
ADSK_CASCADING_OVERRIDE Disables cascading for product releases of 2016 and later. Set the value to 0 (a setting of 1 enables cascading). This setting applies across all products.
ADSKFLEX_LICENSE_FILE Used for connecting a license Server. The address of the license server must be stored either in a config file in your home directory .flexlmrc or can be set as an environment variable ADSKFLEX_LICENSE_FILE. If the server is named mylicenseserver: ~/, .flexlmrc should contain: ADSKFLEX_LICENSE_FILE=@ mylicenseserver or add to your login script: export ADSKFLEX_LICENSE_FILE=@ mylicenseserver Ensure to setup the environment for the user that starts the cluster service.
QTWEBENGINE_CHROMIUM_FLAGS Provides a way to pass Chromium flags to all WebEngine browser instances.
Note: As of 2022.3, the environment variable parameter, "–enable-gpu-rasterization", was removed to fix the Qt 5.155 rendering of transformed SVG graphic issue. However, if you are experiencing lower WebEngine performance than expected, use QTWEBENGINE_CHROMIUM_FLAGS="--enable-gpu-rasterization --ignore-gpu-blocklist" to restore the previous version settings.
VRED_ALLOW_STANDBY_MODE   ADSK_VRED_ALLOW_STANDBY_MODE Any value: Allows the machine to enter sleep mode. By default, VRED prevents sleep mode.
VRED_CLUSTERMANAGER_PATH Provides the path to a user-defined storage location for cluster manager data (database, encrypted project files, and images). This enables you to control the location of these files. For a running system, you can view the info page to see the location of the database file.
VRED_COLLABORATION_NO_AUDIO Any value: Disables the audio for a collaboration session, preventing the use of VRED native audio in Collaboration mode.
VRED_COLLABORATION_NO_UPLOAD Any value: Prevents the upload of scenes in Collaboration mode.
VRED_CURRENT_PROJECT _DIR Read-only: Returns the current directory of loaded VPB file.
VRED_CUSTOM_HANDS Provides the path to a user-defined directory for custom VR hand geometry.
VRED_DATA Read-only: Returns the path to the VRED data directory.
VRED_DEBUG_IDLE_LICENSE Any value: Enables the debug output for License Idle mode.
VRED_DISABLE_ADP Any value: Disables the Autodesk data collection feature.
VRED_DISABLE_CASCADING Any value: Disables license cascading.
VRED_DISABLE_CLIC_IPM Any value: Hides the license UI in VRED.
VRED_DISABLE_CLIC_USER_LICENSE Any value: Disables the user license feature.
VRED_DISABLE_IDLE_LICENSE Any value: Disables the license release on idle.
VRED_DISABLE_ONLINE_STORES Any value: Disables the use of online stores in main window. No UI will be shown.
VRED_DISABLE_SHARED_VIEWS Any value: Removes the menu option Share View from the File menu; therefore, disables the shared views feature. See Disabling Shared Views for instructions.
VRED_DISABLE_WEBINTERFACE | ADSK_VRED_DISABLE_WEBINTERFACE Any value: Disables the VRED web interface. No UI will be shown.
VRED_EXAMPLES Read-only: Returns the path to VRED examples directory.
$VRED_EXAMPLES Use in web URLs, such as $VRED_EXAMPLES/webengine/menu.html, where $VRED_EXAMPLES is the environment variable that's resolved at run-time. This supports a flexible URL file path location. Enter this in the Image option in the Sceneplate Editor.
VRED_FILEIO_TMP_DIR Provides the path to a user-defined file IO tmp dir for VRED.
VRED_FORCE_EGL Any value: Forses the use of EGL (https://www.khronos.org/egl/) under Linux.
VRED_IDLE_LICENSE_TIME Provides the time, in seconds, after which VRED will release the license when on idle. The value is clamped to range [60, 900].
VRED_IGNORE_INVISIBLE 1: Ignores the invisible geometry of non-wire files on import.

Other value: Import invisible geometry.
VRED_PREFERENCES_OVERRIDE Used with the command line parameter, `-preferencesOverride`, for including a config file containing a subset of preferences to overwrite the local preferences for the session upon startup. See Distribute Preferences (2022.3) for more information.
VRED_ROOT Read-only: Returns the path to VRED root directory.
VRED_SCRIPT_PLUGINS Provides the path to a user-defined directory for script plugins.

The subfolder structure of that folder must match the following constraint: Autodesk/VRED-<Version>/ScriptPlugins where <Version> is the number of the VRED release (e.g., 13.0).
VRED_SERVICE_PAGE 0: Completely blocks the web interface.

1: Blocks the web interface http site, but requests are enabled.

2: Completely enables the web interface.
VRED_TMP_DIR Provides the path to a user-defined tmp directory for VRED.
VRED_TRANSLATION_DIR Provides the path to a user-defined directory for translations.
VRED_USE_ALL_TRACKING 0 or not set: Uses a specific tracking module, instead of loading all.

Other value: Loads all tracking module plugins.
VRED_USE_OLD_TRACKING 1: Ignores the new VRPN tracking module and only loads old tracking module.

Other value or not set: Loads the new VRPN tracking module. Requires VRED_USE_ALL_TRACKING = 1 or not set.
VRED_WRITE_IMPORT_DEBUG_FILE 1: Writes the ATF import debug file.

Other value: No debug file.
VRED_WRITABLE_DATA Read-only: Returns the path to VRED writable data directory.
VRED<VersionYear>_SCRIPT_PLUGINS (e.g., VRED2020_2_SCRIPT_PLUGINS) Provides the path to a user-defined directory for script plugins.
<AppName>_LOG_DIR (e.g., VREDPRO_LOG_DIR) Provides the path to a user-defined log directory.

External Variables

These environment variables are external.

External Variable

Value/Explanation
ADLSDK_DARK_SITE In dark site mode, CLIC will avoid sending HTTP requests and disable the user license model. This special mode is desired for customers with restricted Internet connectivity. Set to "TRUE" to turn it on (case sensitive). Any other value will turn it off.
HDRLS_HOME_V4 Provides the path to HDR LightStudio V4 libraries.
HDRLS_HOME_V5 Provides the path to HDR LightStudio V5 libraries.
MAYA_LOCATION Provides the path to the Maya location.
STARVR_SDK Provides the path to the StarVR SDK. This variable should be created in the StarVR SDK installer.

Additional Links

Here are some additional links for working with environment variables: