ConfigurationΒΆ

Guerilla is configured with a local and a user configuration. The local configuration is a machine-based configuration, while the user configuration can be different for each user. The user configuration overrides the local configuration.

When starting up, configuration variables are first searched in the user configuration file, and if not found, the variables are searched in the local configuration. If a variable cannot be found in either of the configurations, the variable gets a default value.

You can access the configuration in Guerilla with the Preferences > Local Settings. When a local setting is changed, the value is written into the user configuration when Guerilla quits.

The local configuration file is /guerilla.conf

The user configuration file is /.guerilla.conf

You can change the configuration files location using the GUERILLA_CONF and GUERILLA_USR_CONF environment variables. Those variables must contain the full path to the configuration file, like /app/guerilla/guerilla.conf.

Variables in configuration

Guerilla accepts environment variables in configuration files. Use ${VARIABLE} (with curly brackets) so Guerilla expands VARIABLE when loading the configuration file.

In this context, the curly bracket syntax is different from the parenthesis syntax used everywhere else in Guerilla, so it is possible to expand ${VARIABLE} to a numeric value which would not be correctly interpreted otherwise with $(VARIABLE).

Environment variables

Here are the environment that are optionally used by Guerilla. None of them is mandatory.

GUERILLA_CONF

The path to the local machine configuration file. When not set, defaults to '/guerilla.conf'.

GUERILLA_USR_CONF

The path to the user configuration file. When not set, defaults to '/.guerilla.conf'.

GUERILLA_THEME

The path to the theme directory. This directory contains bitmap icons that override the default ui/ bitmaps found in the installation.

GUERILLA_CONSOLE_CFG

The path to the console configuration file. This file contains the state of the console window (placement, opened files, etc.) When not set, defaults to guerilla dir/console.cfg (which might not be write permitted.)

GUERILLA_LIBRARY

The path to the Guerilla library. When not set, defaults to guerilla dir/library.

OCIO

The path to the OpenColorIO configuration file. See TD Guide/Technical Notes/OpenColorIO.

GUERILLA_PYTHON_LIBRARY

The path to the Python runtime library to use, such as /usr/lib/libpython2.7.so on Linux or C:/Python/python27.dll on Windows. Note that these variables are dependent on your installation and may vary. See also TG Guide/Technical Notes/Python Scripting for more information.

GUERILLA_AUTO_BUILD_TEXTURES_PATH

The path to the automatic texture build. See also the AutoBuildTexturesPath section in this page.

GUERILLA_ENABLE_CHMOD

Set this to 0 to prevent Guerilla from chmoding files (Linux only.) This is activated by default.

GUERILLA_NTHREADS

Overrides the maximum number of threads available to render.

Local Settings

These settings are read at startup from the user/local configuration.

Licencing

LicenceServerPort - Licence > Licence Server Port

Specifies the port of the licence server. The default port is 19200.

LicenceServer - Licence > Licence Server

Specifies the IP address of the licence server.

LicenceFile - Licence > Licence File

Specifies the location of the licence file. When no licence server is provided, Guerilla will try to use the licence file located at this place. The default location is INSTALL/guerilla.licence where INSTALL is the Guerilla installation directory.

Directories and environment customization

Local Settings > Directories > User Plugins

Specifies a list of custom directories where to find additional plugins. At startup, Guerilla scans those directories and run any Lua script file it finds. Those files must have the 'lua' or 'py' extension.

Items in this list can be separated by either '\n', '\r', ':' or ';', with the exception of 'X:' not treated as a separator for consistency with Windows path. For instance X:/Production/Guerilla/plugins:X:/Project/Guerilla/plugins is treated as X:/Production/Guerilla/plugins and X:/Project/Guerilla/plugins.

Local Settings > Directories > User Library

Specifies the location of custom libraries. Items in this list can be separated by either '\n', '\r', ':' or ';', with the exception of 'X:' not treated as a separator for consistency with Windows path. Each directory can have an option =NAME specifier used in the library as display. For instance /production/guerilla/lib=SiteLibrary:/show/guerilla/lib=ShowLibrary will add /production/guerilla/lib (displayed as SiteLibrary) and /show/guerilla/lib (displayed as ShowLibrary) in the Library view.

UserPlugins and UserLibrary can use environment variables, so /$(SHOW)/guerilla/lib is a valid directory as long as SHOW is an environment variable.

Local Settings > Directories > Local Environment

Specifies additional environment variables to be declared within Guerilla. These environment variables can be accessed in scripts/plugins.

CPU management

NThreads - CPU > Threads

Specifies the number of threads to use.

MaxThreads - CPU > Max Threads

Specifies the maximum number of threads to use. This value clamps the NThreads variable.

Memory management

RAMResourceAmount - Cache Manager > RAM Resource Amount

Specifies the size (in fraction of the system memory) of the texture and geometry cache. The default value is 0.75 (3 quarters of the system RAM)

File management

PathMap

Specifies a list of semicolor separated prefix/replacement pairs of string. All file paths going through Guerilla will be remapped if they match the prefix. For instance:

PathMap = D:\=/driveD/;/home/user=C:\Users\user

will map C:\a\path to /driveD/a/path and /home/user/diffuse.tex to C:\Users\user/diffuse.tex

Texture management

Internally, Guerilla uses texture files (.tex) but allows you to provide bitmap files instead, which are mapped to texture files. By default, this is automatic and transparent to users, but this behaviour can be controlled to fit your requirements using the following configuration variables:

AutoBuildTextures

Allows the GUI to build .tex files when missing or outdated. Setting this to 0 prevents the GUI from automatically building tex files.

The default value is 1.

This value can be changed in the GUI in 'Preferences > Local Settings > Texture Manager > Auto Build Textures'

RenderAutoBuildTextures

Allows the batch/farm renderer to build .tex files when missing or outdated. Setting this to 0 prevents the renderer from automatically building tex files.

The default value is 1.

AutoBuildTexturesPath

The mapping configuration from bitmap files to tex files. The default value is:

$(DIRECTORY)/.guerilla/$(FILE)_$(FILTER)_$(MODE)$(_CHANNEL).tex

where

  • $(DIRECTORY) is the directory of the original bitmap
  • $(FILE) is the base name of the original bitmap
  • $(FILENOEXT) is the base name of the original bitmap without extension
  • $(EXT) is the original bitmap extension
  • $(FILTER) is the filter name
  • $(MODE) is the clamp/wrap mode
  • $(CHANNEL) is the channel name

For instance, this remaps '/a/path/to/my/bitmap.png' to '/a/path/to/my/.guerilla/bitmap.png_triangle_ww.tex', assuming a triangle filter and a wrap/wrap lookup mode.

If you want the tex file to sit next to your bitmap file, with identical name, use:

$(DIRECTORY)/$(FILENOEXT).tex

which remaps '/a/path/to/my/bitmap.png' to '/a/path/to/my/bitmap.tex'.

Note that the previous tokens can have an '_' character so it is possible to specify optional _ separators in the resulting texture path as seen with $(_CHANNEL). The GUERILLA_AUTO_BUILD_TEXTURES_PATH environment variable overrides this value.

Low Quality rendering

LowSamples - Low Quality Render > Low Samples

Sample count in low quality render.

LowStereo - Low Quality Render > Stereo

Enables/disables the stereo rendering for low quality rendering.

LowLayerSizeDivisor - Low Quality Render > Layer Size Divisor

Divides the size of the rendered image.

LowVolumeStepDivisor - Low Quality Render > Volume Step Divisor

Divides the number of volumetric ray marching steps.

Stereoscopy

StereoMode

Specifies the OpenGL stereoscopic display mode. Possible values are:

  • Disable: no stereo display
  • Anaglyph: color anaglyph
  • AnaglyphBW: black and white anaglyph
  • Interleaved: left and right cameras are interleaved over the scan lines. Requires an interleaved monitor.
  • SideBySide: leftiew is displayed on the left monitor, right view is displayed on the right monitor. Both monitors mush share the same desktop
  • QuadBuffer: uses NVidia Quadro's quad-buffered stereo support.

InvertStereo

Flip eyes for stereo display

LeftFilter

Anaglyph left eye color filter

RightFilter

Anaglyph right eye color filter

OpenGL

ScreenGamma

Gamma space of the screen

VRAM

Indicative amount of video memory mounted on graphic card, in megabytes

MaxRTLights

DEPRECATED Maximum number of displayable lights in OpenGL

GUI

SnappingDistance

Snapping distance in pixels, for the snap to surface/edge/vertex tool

ConsoleConfig

Location of the console configuration file. Defaults to GUERILLA_CONSOLE_CFG environment variable, or $GUERILLA/console.cfg

DebuggerEnabled

Indicates if Lua debugger is enabled (1)

ShortCutsFile

Location of the shortcuts file

CommandPort

TCP port to send Lua commands to a Guerilla host.

UIDefaultLayout

Location of the default UI layout file to load. Defaults to $GUERILLA/default.glayout

RecentFiles

Location of recently opened files.

FarmInterface

Active farm interface.

DocumentLoadingLogs

Display loading logs and warnings

UIThemePath

Additionnal directory for UI bitmaps

MenuBackOpacity

Background opacity of the contextual/right menu

Console

Command line console to execute batch jobs

Renderer

ProgressMessage

Progression message displayed by the renderer.

StartupDiagnostic

Forces the display of startup diagnostics.

StopOnError

Forces the renderer to stop at the first encountered error.

RenderQuickExit

Forces the command line renderer to exit quickly without performing routine clean up. This usually results in faster exit and prevents releasing crashes, but may leave some temporary buffers unfinished.