CueServer 2 User's Manual

show.cfg

The show.cfg file is a simple text file in LibConfig format. This file is located in the root of the show’s file system directory structure.

The following elements appear in the show.cfg file:

astro Dictionary (astro) Contains a dictionary of Astronomical Time configuration elements.
audio Dictionary (audio) Contains a dictionary of Audio configuration elements.
description String A textual description for the show file that appears in the Settings/Description panel of CueServer Studio.
dmx Dictionary (dmx) Contains a dictionary of DMX configuration elements.
lcd Dictionary (lcd) Contains a dictionary of LCD Display configuration elements.
name String DEPRECIATED: This element used to contain the name of the show. Now, the actual name of the show file directory is used as the show’s name.
preferredModel Integer Contains the Model ID number of the “preferred” CueServer model for this show file. CueServer Studio uses this ID to display the correct UI for specific configuration elements that are different for each model.
  • 0 = Any
  • 160 = CS-900
  • 176 = CS-920
  • 224 = CS-940
station Dictionary (station) Contains a dictionary of Station related configuration elements.

‘astro’ Dictionary

The following elements appear in the astro dictionary:

latitude Float The device’s latitude coordinate (in degrees, for example 34.24963).
longitude Float The device’s longitude coordinate (in degrees, for example -84.05723).
offset Float DEPRECIATED: This element had previously been used to specify the device’s offset from UTC/GMT. Now the time zone offset is retrieved from the system’s global clock settings.

‘audio’ Dictionary

The following elements appear in the audio dictionary:

volume Integer The audio output volume (from 0 to 100).

‘dmx’ Dictionary

The following elements appear in the dmx dictionary:

channelCount Integer The number of channels being output (must be equal to universeCount * 512).
playbackCount Integer The number of playbacks configured.
playbacks Dictionary Array (playbacks) An array containing the configuration dictionaries for each playback.
ports Dictionary Array (ports) An array containing the configuration dictionaries for each port.
universeCount Integer The number of CueServer universes configured (must be equal to channelCount / 512).
universes Dictionary Array (universes) An array containing the configuration dictionaries for each universe.

‘dmx/playbacks’ Dictionary

The following elements appear in the dmx/playbacks dictionary:

name String The descriptive name for the playback (may be blank).
mode Integer An ID for the default mode of the playback.
  • 0 = Merge
  • 1 = Override
  • 2 = Scale
  • 3 = Pin

‘dmx/ports’ Dictionary

The following elements appear in the dmx/ports dictionary:

direction Integer The input/output “direction” for the port. [OPTIONAL]
  • 0 = Off
  • 1 = Input
  • 2 = Output
universe Integer The CueServer universe number (1..32) corresponding to this port. Previous versions of CueServer used universe 0 to mean that the port was disabled, which is depreciated. Instead use the direction element to indicate that a port is disabled.

‘dmx/universes’ Dictionary

The following elements appear in the dmx/universes dictionary:

channels Integer The number of channels in this universe (1-512). If this element is missing, the default is 512.
name String Descriptive name for the universe (may be blank).
rx_port Integer The port number for KiNET v2 protocol. Only used for the KiNET v2 protocol.
rx_priority_high Integer High limit of the priority range of received packets (0-200). Only used for the sACN protocol.
rx_priority_low Integer Low limit of the priority range of received packets (0-200). Only used for the sACN protocol.
rx_protocol Integer Number of protocol to use for receiving DMX over Ethernet for this universe.
  • 0 = None
  • 1 = sACN
  • 2 = KiNet v1
  • 3 = KiNet v2
  • 4 = Art-Net
rx_universe Integer External universe number to receive channels from.
  • sACN = Universe 1..63999
  • KiNET = Universe 0..2147483647, -1 = All
  • Art-Net = Port-Address 0..32767
tx_flags Integer The transmit flags for KiNET v2.
  • 0×01 = Chromatic
  • 0×02 = Sync Packets
tx_ip String IP Address to transmit packets to. Only used for KiNet and Art-Net protocols.
tx_mode Integer DEPRECIATED: This element had previously been used to specify the Art-Net broadcast mode. Now the broadcast mode is implied by special values in the tp_ip element.
tx_port Integer The port number for KiNET v2 protocol. Only used for the KiNET v2 protocol.
tx_portout String DEPRECIATED: This element had previously been used to list KiNET v2 “portout” parameters.
tx_priority Integer Priority level for transmitted packets (0-200). Only used for the sACN protocol.
tx_protocol Integer Number of protocol to use for transmitting DMX over Ethernet for this universe.
  • 0 = None
  • 1 = sACN
  • 2 = KiNet v1
  • 3 = KiNet v2
  • 4 = Art-Net
tx_universe Integer External universe number to transmit channels to.
  • sACN = Universe 1..63999
  • KiNET = Universe 0..2147483647, -1 = All
  • Art-Net = Port-Address 0..32767

‘lcd’ Dictionary

The following elements appear in the lcd dictionary:

top-left Integer The ID of the display element that will appear in the top-left of the LCD Display. Possible values include:
  • 0 = None
  • 1 = Device Name
  • 2 = Long Time/Date 12 Hour
  • 3 = Short Time/Date 12 Hour
  • 4 = Long Time/Date 24 Hour
  • 5 = Short Time/Date 24 Hour
  • 6 = Long Date
  • 7 = Short Date
  • 8 = 12 Hour Time
  • 9 = 24 Hour Time
  • 10 = User String
  • 11 = IP Address
  • 12 = Timecode
  • 13 = I/O Status
  • 14 = CPU Load
  • 15 = Show Path
  • 16 = Show Name
top-right Integer The ID of the display element that will appear in the top-right of the LCD Display (uses same constants as above).
bottom-left Integer The ID of the display element that will appear in the bottom-left of the LCD Display (uses same constants as above).
bottom-right Integer The ID of the display element that will appear in the bottom-right of the LCD Display (uses same constants as above).
backlight Integer The brightness level of the LCD backlight (from 0 to 255).

‘station’ Dictionary

The following elements appear in the station dictionary:

onColor String The default onColor for stations, represented as a hexadecimal string. For example, an Orange color would be represented as FF8800. Colors may optionally have an Alpha component, which is used to denote the flash pattern. For example, Green with a flash pattern of 3 would be represented as 00FF0003.
offColor String The default offColor for stations, represented as a hexadecimal string.
mixedColor String The default mixedColor for stations, represented as a hexadecimal string.
lockedColor String The default lockedColor for stations, represented as a hexadecimal string.
user1Color String The default user1Color for stations, represented as a hexadecimal string.
user2Color String The default user2Color for stations, represented as a hexadecimal string.
user3Color String The default user3Color for stations, represented as a hexadecimal string.
user4Color String The default user4Color for stations, represented as a hexadecimal string.