Configuration

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

The file is overwritten when the application is closed, after which it will contain all the configuration options in use - thus, you will not have add any content to the file, merely modify it. For that reason, this section will be a reference of the semantics of the options, rather than their markup.

The option's type is shown in parantheses after the option name.

General options

action_batch_size (int)
Actions are processed in batches, this option defines the size of those batches. Large values will, in theory, give better throughput whilst small values will yield lower latency. In practice, you probably don't need to fiddle with this option.
Default: 20
default_scene (path)
Specifies a scene file to be loaded at startup. By default, a scene containing naught but a grid is loaded. You can override this behaviour by changing this option or placing your own default_scene.xml in ~/.peekabot/scenes.
Default: default_scene.xml
enable_debug_log (bool)
If true, debug messages will be written to ~/.peekabot/debug.log.
Default: false
model_dirs (list of paths)
The directories in which peekabot looks for models and textures, in priority order.
Default:
  • ~/.peekabot/models
  • ~/.peekabot/robots
  • ~/.peekabot/scenes
  • pkgdatadir/models
  • pkgdatadir/robots
  • pkgdatadir/scenes
robot_dirs (list of paths)
The directories in which peekabot looks for robot definition files, in priority order.
Default:
  • ~/.peekabot/robots
  • pkgdatadir/robots
scene_dirs (list of paths)
The directories in which peekabot looks for scene definition files, in priority order.
Default:
  • ~/.peekabot/scenes
  • pkgdatadir/scenes
snapshot_dir (path)
The directory where peekabot saves snapshots and snapshot sequences.
Default: ~/.peekabot/snapshots
parser.schema_dir (path)
The directory where peekabot searches for XML schemas.
Default: pkgdatadir/schemas
parser.validate (bool)
Enable/disable schema validation when parsing XML files - disable at your own risk!
Default: true
network.listen_port (int)
The port on which peekabot listens for incoming client connections. Overriden by the --port command line option.
Default: 5050

GUI options

gui.fps (int)
The maximum frequency which each viewport is redrawn per second.
Default: 20
gui.gui_fps (int)
The maximum frequency which each viewport is redrawn per second when there's GUI activity.
Default: 20
gui.icon_dir (path)
The directory where peekabot searches for icons used in the GUI.
Default: pkgdatadir/images
gui.viewports.background_color (color)
The background color of the viewports.
Default: (1, 1, 1)
gui.viewports.selected_color (color)
The color used to outline selected objects.
Default: (0, 0.3, 1)
gui.viewports.parent_selected_color (color)
The color used to outline objects who has a selected ancestor.
Default: (0.5, 0.75, 1)

Renderer options

renderer.disable_vbos (bool)
Forcefully disable the use of Vertex Buffer Objects (VBOs). VBOs can cause problems with certain hardware and drivers.
Default: false
renderer.enable_multisampling (bool)
Try to enable full scene anti-aliasing (FSAA).
Default: true
renderer.octree.min_node_size (float)
The minimum allowed size of octree nodes. You shouldn't normally need to alter this setting.
Default: 1
renderer.octree.purge_threshold (int)
Sets the condition on when unnecessay octree nodes are purged. For highly dynamic and static scenes a large and a small value might improve performance. You shouldn't normally need to alter this setting.
Default: 100

Get peekabot at SourceForge.net. Fast, secure and Free Open Source software downloads
Generated on Tue Mar 17 22:47:12 2009 for peekabot by  doxygen 1.5.6