Configuration options

Configuration of the peekabot server is done using the file ~/.peekabot/peekabot.conf (again, on Windows, the .peekabot directory is located in your Application Data directory).

The configuration uses INI-like syntax, as illustrated below. Versions prior to 0.6.0 used an XML-formatted configuration file, config.xml.

[section-name]

# A comment
option-name = option-value

[other-section]

; Alternate comment syntax
a-multi-value-option = separate, multiple, values, with, commas

# Booleans accept a few different, equivalent values
bool1 = 0
bool2 = false
bool3 = on
bool4 = enable

# Colors are defined as a comma separated RGB triplets, with components
# in the 0-1 range.
color1 = 1,1,1   # White
color2 = 1, 0, 0 # Red

Below, the option's type is shown in parentheses after the option name.

[resources]

share_path (path)

The directory where peekabot essential resources can be found - icons, schemas, etc.

Default: $pkgdatadir

data_paths (paths)

The directories in which peekabot looks for scenes, models and textures in addition to the global (/usr/share/peekabot/data/ or similar) and user local paths (~/.peekabot/data/). User local paths have the highest priority, and global paths the least. Paths added with this option fall in between.

Default: Empty

snapshot_path (path)

The directory where peekabot saves snapshots and snapshot sequences.

Default: ~/.peekabot/snapshots/

[gui]

max_fps (float)

The maximum number of times per second the scene frames are redrawn.

Default: 40

update_freq (float)

The maximum frequency in which the GUI is updated in, e.g. how often the properties in the side bar are updated.

Default: 10

background_color (color)

The background color of scene frames.

Default: 1, 1, 1

selected_color (color)

The color used to draw the outlines for selected objects.

Default: 0, 0.3, 1

ancestor_selected_color (color)

The color used to draw the outlines for objects which have a selected ancestor but are not selected themselves.

Default: 0.5, 0.75, 1

[network]

listen_port (int)

The port on which peekabot, by default, listens for incoming client connections.

Default: 5050

[renderer]

disable_vbos (bool)

Forcefully disable the use of Vertex Buffer Objects (VBOs). VBOs can cause problems with certain hardware and drivers.

Default: false

[debug]

debug_log (bool)

If true, debug messages will be written to ~/.peekabot/debug.log.

Default: false