Skip to content

Config File Format

Jump to bottom
Steve Richardson edited this page May 12, 2024 · 6 revisions

Deckard Config File

The Deckard config file is a standard .INI file format, as parsed by Python configparser. The config file location is supplied as the first argument to decker.py in the loadusr command of the HAL file.

[General] Section

This section controls global settings.

  • Verbose = [True | False] - When True, extra debug output will be sent to the console.
  • Brightness = [integer 1-100] - Set the overall brightness of all StreamDecks in use

[key.##] Sections

These sections are used to configure the behavior of each key the StreamDeck. They are indexed from 00 to num_keys-1 (e.g. 00-31 on a large StreamDeck), and the index replaces the ## in the section name (e.g. [key.00]). Note the leading zero for indices < 10, it must be present.

Key configuration and HAL behavior

  • Type = [unused | momentary | toggle | toggle2] - Behavior of this button. Only unused and momentary are supported for now. Native toggle types may be supported in the future, as well as other more advanced types of buttons.
  • PinAlias = (string) - Instead of the HAL pins for this key being identified by the key index number, they can have a unique name set by this option.
  • EnablePin = [True | False] - Creates a HAL enable pin for this key, which can be used to disable its behavior. If the HAL enable pin for the key is set to False, the key will be shown as disabled with visual cues (darkening and mild blur).

Labels

  • InactiveLabel = (string) - Label shown when the in state is False.
  • ActiveLabel = (string) - Label shown when the in state is True.

Labels may be multi-line using the following syntax (note the tabbing of the second line):

InactiveLabel = Toggle
	      	One
ActiveLabel = TOGGLED
	      ONE

By default the labels will appear centered in the button.

Visual Appearance

Color strings may be a color name (e.g. 'red') or an RGB color (e.g. #ff0000 for red). See pillow colors for more info.

  • InactiveLabelColor = (string) - Color of the inactive label.
  • ActiveLabelColor = (string) - Color of the active label.
  • InactiveBackground = (string) - Background color when inactive.
  • ActiveBackground = (string) - Background color when active.
  • FontSize = (int) - Font size (in pixels?). The font style is currently not adjustable, but will be in the future.

Example:

InactiveBackground = gray
ActiveBackground = green
InactiveLabelColor = #000000
ActiveLabelColor = #ffffff
FontSize = 20

Clone this wiki locally