HDR Light Studio has a range of environment variables that can control it.
Instructions on how to add Environment Variables can be found on this page, showing how to set them up for Logging, but the same process can be used for all the environment variables below.
HDRLS_HOME_V5
If you intend to use HDR Light Studio with a connection to a 3D apps such as Maya, 3ds Max and Cinema 4D, you will need the environment variable HDRLS_HOME_V5 set on your system pointing to the directory containing the HDR Light Studio executable. This tells the plug-in connection where to find the HDR Light Studio application. This environment variable is required for all platforms, it is setup for you automatically on Windows and MacOS during installation, but for Linux will need manually configuring as there is no set installation process.
HDR Light Studio currently supports ASCII characters only in file paths. Therefore you may want to use these environment variables (HDRLS_USER_DIR and HDRLS_TEMPRENDER_DIR) if your OS account username contains none ASCII characters, in order for HDR Light Studio to work properly. For example when using HDR Light Studio with 3ds Max. (Please note: Other Connections may not currently function correctly, even after using this override when you have a none ASCII character in your username).
HDRLS_USER_DIR
The HDR Light Studio user directory by default contains folders containing these files that HDR Light Studio needs: license files, presets, user presets, presets cache and favorites preset settings file.
With a default installation this path will be, for example on Windows: C:\Users\Username\AppData\Local\lightmap
If you wish to store these files in a different location, you can set the environment variable HDRLS_USER_DIR.
For example:
HDRLS_USER_DIR = \DiskName\HDRLS_DATA\USER\
HDR Light Studio currently supports ASCII characters only in file paths. Therefore you may want to use this setting if your OS account username contains none ASCII characters, in order for HDR Light Studio to work properly. For example when using HDR Light Studio with 3ds Max. (Please note: Other Connections may not currently function correctly, even after using this override when you have a none ASCII character in your username).
HDRLS_TEMPRENDER_DIR
When using HDR Light Studio, it create's temporary files shared with your 3D software, and temporary files during rendering.
With a default installation this path will be, for example on Windows: C:\Users\Username\AppData\Local\Temp\
Files will be created within subfolders in that location, for example all temp image files are stored in: HdrlsBuckets_Lightmap Ltd
If you wish to store these files in a different location, you can set the environment variable HDRLS_TEMPRENDER_DIR.
For example:
HDRLS_TEMPRENDER_DIR = \DiskName\HDRLS_DATA\TEMP\
HDRLS_LOG_FILE
Diagnostic information can be written to a text file while using HDR Light Studio. Just set the environment variable HDRLS_LOG_FILE to a text file in a directory. The directory path must exist but the log file will be created on starting HDR Light Studio.
For example, on Windows:
HDRLS_LOG_FILE = C:\Users\Username\Documents\lightmaplogs\hdrls.log
Every time the app is launched the old log file will be renamed and a new log file created. This value can been seen (if set) in the Preferences dialog.
HDRLS_LOG_LEVEL
The verbosity of the diagnostic information written to the log file can be controlled with the environment variable HDRLS_LOG_LEVEL. Values range from 0 (a little information) to 5 (full information).
For example, on Windows:
HDRLS_LOG_LEVEL = 1
This log level value can been seen (if set) in the Preferences dialog.
HDRLS_PRESETS_DIR
Larger studios may wish to set an environment variable (in a login script maybe) to point all their artists to a central server storing the Preset Lights. These are over 8GB of files at the moment, and it will save time needing to install these files on each users machine. This setting will override the path set with HDRLS_USER_DIR environment variable.
For example:
HDRLS_PRESETS_DIR = \DiskName\HDRLS_Presets\
HDRLS_LICENSE_DIR
Large studios may wish to set an environment variable (in a login script) to point all their artists to a central location for their license keys. This is useful when there is a floating license server. Every user will have the same client.lic file pointing to the same licenses server. This way if the license server is updated, changing the single client.lic file in the central location will let all HDR Light Studio seats use the new floating license server. This setting will override the path set with HDRLS_USER_DIR environment variable.
For example:
HDRLS_LICENSE_DIR = \DiskName\HDRLS_Licenses\
OCIO
OpenColorIO (OCIO) is a complete color management solution geared towards motion picture production with an emphasis on visual effects and computer animation.
Lightmap supports OCIO in HDR Light Studio. By default HDR Light Studio ships with a set of OCIO config files located here for example on Windows: C:\Program Files\Lightmap\HDR Light Studio\OCIOConfigs
The OCIO environment variable allows you to specify your OCIO config file.
Here's an example pointing to some Nuke defaults that ship with HDR Light Studio:
OCIO = C:\Program Files\Lightmap\HDR Light Studio\OCIOConfigs\nuke-default\config.ocio
Please note: When specifiying the OCIO path, slashes should be the correct way for the platform you are on, and not doubled up.
For example: \\cgi-shotgun\library\OCIO_Configs\aces_1.2_marks\config_marks_01.ocio
and not \\\\cgi-shotgun\\library\\OCIO_Configs\\aces_1.2_marks\\config_marks_01.ocio
This value can been seen (if set) in the Preferences dialog. For further information see http://opencolorio.org/
HDRLS_SCALE_GUI
Forces scale of the User Interface through HDRLS_SCALE_GUI environment variable. The value represents the scale size you want. 1 = 100%, 2 = 200% etc.
For example, to double the scale of the UI:
HDRLS_SCALE_GUI = 2
HDRLS_TMPDIR_OVERRIDE
This environment variable changes the location of our system mutexes from the default posix TMPDIR location to that specified in the new environment variable. This allows customers that have non-standard and custom setups to set it to somewhere else so that HDR Light Studio can actually run. The directory set must have already been created. We will not create it if it is not found.
Plug-in Connection TCPIP API Communication Ports
Some plug-ins use our new TCPIP based API which is nice and fast. In rare occasions, our default TCPIP port settings for communications can be in conflict with other software. For example, Teradici PCoIP remote protocol uses port 5555 and prevents HDR Light Studio from working with default settings.
Here are the Environment Variables you can set to change the port settings for HDR Light Studio TCPIP communication.
HDRLS_LOCAL_PORT The default setting without an environment variable is: 5555
HDRLS_REMOTE_PORT The default setting without an environment variable is: 5556
HDRLS_HEARTBEAT_SVR_PORT The default setting without an environment variable is: 5557
HDRLS_HEARTBEAT_CLI_PORT The default setting without an environment variable is: 5558
