The panel.cfg file format

■ Contenu

• 1. Overview
• 2. Syntax
• 3. The Panel section
• 4. The View section
• 5. The PressureIndicator section
• 6. The SpeedIndicator section
• 7. The DigitalIndicator section
• 8. The PilotLamp section
• 9. The Watch section
• 10. The BrakeIndicator section

■ 1. Présentation

The panel.cfg file allows to create 2D panels by defining which elements to use, like speedometers, pressure gauges etc., and where they are to be placed.

The panel.cfg file is a plain text file encoded in any arbitrary encoding, however, UTF-8 with a byte order mark is the preferred choice. The parsing model for numbers is Loose, however, you are encouraged to produce Strict output nonetheless. The file is required to be located inside the train folder and is expected to be named panel.cfg. The file is interpreted on a per-line basis, from top to bottom.

➟ See also the quick reference for the panel.cfg…

■ 2. Syntaxe

Each line in the file can be empty (or solely consist of white spaces) and will be ignored, can mark the beginning of a new section or contain key-value pairs inside a section. All key-value pairs relate to the last section opened.

A new section is opened by starting the line with an opening bracket (U+005B) and ending it with a closing bracket (U+005D). The text in-between the brackets indicates the name of the section and is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as at the beginning and the end of the name of the section. Thus, the beginning of the section has the following form:

A key-value pair is indicated by giving the key, an equals sign (U+003D) and then the value. The key is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as in front and after the equals sign. Alternatively, white spaces surrounding the key and the value are ignored. Thus, a key-value pair as the following form:

Some values are further split into multiple parts, separated by commas (U+002C). Instead of a comma, a colon (U+003A) can be used interchangeably.

You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed.

■ 3. The Panel section

The Panel section defines which background image to use. Only one Panel section is expected in a panel.cfg file.

This starts the section.

Defines which background image to use. File is relative to the train folder. The image is aligned at the bottom-left of the screen, where a width of 480 corresponds to the right edge of the screen. You cannot meaningfully use images of larger width with the panel.cfg. Consider using the panel2.cfg if you want to employ images of any size. If this key-value pair is not used, the background image file is implicitly assumed to be called Panel.bmp. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

■ 4. The View section

The View section defines the viewing angle conditions. Only one View section is expected in a panel.cfg file.

This starts the section.

Defines the pitch of the view. Any value entered will be additionally subtract by 11 degrees, resulting in a slight downward pitch if ValueInDegrees is 0. If this key-value pair is not used, the final viewing angle will be -11 degrees.

■ 5. The PressureIndicator section

This section creates a pressure indicator. You can use as many of these sections as required.

This starts the section.

▸ Options for Value:

This defines the type of the pressure indicator. While both the gauge type and the LED type indicators can show two different pressures, this is not generally useful for the LED type as the upper LED shape will block the view into the lower LED shape.

▸ Options for Subject:

Creates the lower needle for a gauge-type pressure indicator, or defines the color of the lower shape for an LED-type indicator.

▸ Options for Subject:

Creates the upper needle for a gauge-type pressure indicator, or defines the color of the upper shape for an LED-type indicator.

For gauge-type indicators, defines the radius of the pressure gauge needle in pixels. For LED-type indicators, defines half the edge length of the LED-square in pixels. The radius is measured in pixels of the panel image.

Creates a background for the pressure indicator. The background is shown below the needles or the LED-square. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

Creates a cover for the pressure indicator. The cover is shown on top of the needles or the LED-square. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

▸ Options for Value:

Defines the minimum pressure corresponding to the Angle measured clockwise from the 6 o’clock position. The default value is 0.

Defines the maximum pressure corresponding to the Angle measured counter-clockwise from the 6 o’clock position. The default value is 1000.

Defines the angle, measured clockwise from the 6 o’clock position, corresponding to the Minimum pressure, and also the angle, measured counter-clockwise from the 6 o’clock position, corresponding to the Maximum pressure. The default value is 45.

■ 6. The SpeedIndicator section

This section creates an analog speed indicator. You can use as many of these sections as required.

This starts the section.

▸ Options for Value:

Defines the color for the needle (gauges) or for the overlay (LEDs).

For gauge-type indicators, defines the radius of the pressure gauge needle in pixels. For LED-type indicators, defines half the edge length of the LED-square in pixels. The radius is measured in pixels of the panel image.

Creates a background for the pressure indicator. The background is shown below the needles or the LED-square. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

Creates a cover for the pressure indicator. The cover is shown on top of the needles or the LED-square. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

Defines the maximum speed corresponding to the Angle measured counter-clockwise from the 6 o’clock position. The default value is 120.

Defines the angle, measured counter-clockwise from the 6 o’clock position, corresponding to the Maximum speed. The default value is 60.

Creates ATC indicators. The bitmap is required to have 13 square elements stacked horizontally, anchored at the right of the bitmap. The height of the bitmap defines the size of one square element. From left to right, the elements represent:

• 1^st: ATC not currently available
• 2^nd: 0 km/h speed restriction
• 3^rd: 15 km/h speed restriction
• 4^th: 25 km/h speed restriction
• 5^th: 45 km/h speed restriction
• 6^th: 55 km/h speed restriction
• 7^th: 65 km/h speed restriction
• 8^th: 75 km/h speed restriction
• 9^th: 90 km/h speed restriction
• 10^th: 100 km/h speed restriction
• 11^th: 110 km/h speed restriction
• 12^th: 120 km/h speed restriction
• 13^th: ATS currently active

The center of any of the indicators is placed on a circle defined by Center as the center of the circle and AtsRadius as the radius of the circle. The angle at which an element is placed on that circle corresponds to the respective speed, or to the 6 o’clock position for the ATC not currently available and ATS currently active indicators. Only the one currently representative indicator is shown. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

■ 7. The DigitalIndicator section

This section creates a digital speed indicator. You can use as many of these sections as required.

This starts the section.

Creates a three-digit decimal speed display in kilometers per hour (km/h). The bitmap is required to have 11 elements stacked vertically, anchored at the top-right of the bitmap. From top to bottom, the 1^st through 10^th elements represent the digits 0 through 9, while the 11^th element represents a missing digit that is shown in the 10s when the speed is below 10 km/h, and in the 100s when the speed is below 100 km/h. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

Defines the size of a single digit. Is required to be specified.

▸ Options for Value:

■ 8. The PilotLamp section

This section creates a door indicator. You can use as many of these sections as required.

This starts the section.

■ 9. The Watch section

This section creates a watch consisting of needles for hour, minute and second. You can use as many of these sections as required.

This starts the section.

Creates a background for the watch. The background is shown below the watch needles. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

Defines the color for all of the three needles (second, minute and hour).

■ 10. The BrakeIndicator section

This section creates an indicator depicting the state of the power and brake handles. You can use as many of these sections as required.

This starts the section.

Creates an indicator depicting the state of the power and brake handles. The bitmap is required to have a certain number of elements (depending on the train characteristics) stacked horizontally, anchored at the left of the bitmap. The height of the bitmap is equivalent to the height of an element. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels. The meaning of the elements depends on the type of brake systems used:

For air brakes, from left to right:

• Power notch n
• Power notch n-1
• …
• Power notch 2
• Power notch 1
• Release (REL)
• Lap (LAP)
• Service (SRV)
• Emergency brake (EMG)

For notched brakes without the hold brake device, from left to right:

• Power notch n
• Power notch n-1
• …
• Power notch 2
• Power notch 1
• Neutral
• Brake notch 1
• Brake notch 2
• …
• Brake notch m-1
• Brake notch m
• Emergency brake

For notched brakes with the hold brake device, from left to right:

• Power notch n
• Power notch n
• Power notch n-1
• …
• Power notch 2
• Power notch 1
• Neutral
• Hold brake
• Brake notch 1
• Brake notch 2
• …
• Brake notch m-1
• Brake notch m
• Emergency brake