Some of 3Delight's configuration must be done through options that are specified in the 3delight.config configuration file. This configuration is usually done at the time of installation and is best left to the system administrator or the person doing the installation. The renderer looks for the 3delight.config file at several locations in the following order:

  1. In 3Delight's installation directory, as specified by the $DELIGHT environment variable.
  2. In the directories specified by the $DELIGHT_CONF environment variable (a colon separated list).
  3. In user's home directory, as specified by the $HOME environment variable.

If 3Delight encounters the file in more than one location, it uses the latest keys and values it finds (so that latter options settings override former ones). This enables to have a site specific configuration file in the $DELIGHT or $DELIGHT_CONF directories and user specific settings in their home directory. The former often is best left to the system administrator responsible for the software installation.

Each line in the configuration file is of the form "key value1 [value2 ... value_n]". The recognised keys are:

KeyDescription

networkcache.directory

Specifies the directory (folder) for 3Delight's network caching. Should point to a directory located on a local drive (disk or, better yet, SSD) on each render nodes.

>>> THIS NEEDS TO BE IMPLEMENTED: By default, the network cache directory is:  

on Linux → /var/tmp/3DelightCache

on Windows → %TEMP%\3DelightCache — which typically translates to:
C:\Users\User Name\AppData\Local\Temp(%USERPROFILE%\AppData\Local\Temp\3DelightCache)

networkcache.size

Specifies the maximum size (in GB) for 3Delight's network cache. The recommended minimum size is 30GB. Large projects (with lots of texture maps) could easily benefit from 100GB or more.

>>> CLARIFY WHAT TURNS NETWORK CACHE ON???

texturememory


Specifies the size (in MB) of the texture cache held in memory by 3Delight for faster access. Generally, a cache size of 1000MB is enough (and this is 3Delight's default size). Raise this value if a lot of textures are used and your computer(s) have a lot of RAM to spare. In most cases, we would not recommend to raise it to more than 25% of the size of physical RAM.  Note that this cache is for textures in RAM and is completely different than the Network Cache, which is for textures on local disk.

license.server

Specifies the name or IP address of the server used to run 3Delight's license server 'licserver'.

license.hold

By default, the renderer will request new licenses for every render and release them once it’s done. Multiple request/release can be undesirable if several frames are rendered in sequence from the same process. If this option is set to 1, the licenses obtained for the first frame are held until the last frame is finished.

license.wait

If this is set to 1, 3Delight will wait for a license when no license are available for rendering. Otherwise (if it is set to 0), 3Delight will stop/exit if no licenses are available. The latter setting is useful when managing a render farm and other work could be scheduled instead of leaving a machine waiting for a license for rendering.


The following is the default 3delight.config file content (included in the 3Delight's installation directory):


# This 3Delight file allows you to set some configuration options. The format
# is simple: each line is a key/value pair linking an option to a specific value.
# Lines starting with a "#" character are ignored (they serve as comment lines).
# Example:
#
#   networkcache.directory /var/tmp/3DelightCache
#
# Recognized keys are:
#
#   networkcache.directory : Set location of 3Delight's texture cache.
#   networkcache.size      : Set the maximum size of the texture cache on disk (in GB).
#   texturememory          : Set the maximum size of the texture cache in memory (in MB).
#   license.server         : The name or address of the license server.
#   license.hold           : 1 means avoids releasing licenses between frames of a sequence.
#   license.wait           : 1 means wait for a license to be freed when none are available.
#
# A more detailed documentation is available here:
# https://3delight.atlassian.net/wiki/display/3DFM/The+3delight.config+Configuration+File