View Configuration Files

<< Click to Display Table of Contents >>

Navigation:  Support > Athena Support > Spectator Displays > Composing Configuration Files for the Spectator Displays >

View Configuration Files

Description

A View Configuration defines a series (1 or more) View Definitions to load into the Spectator Display along with optional Marquee Messages (the bottom strip). There is usually one View Configuration for each segment of a match. A View Configuration will be loaded into the Spectator Display after a Display Event happens, and is mapped by an Event Assignment.

File Type and Location

View Configuration files are JSON text files that must be edited by hand. They are located in the My Matches/DATABASE/Display/ViewConfiguration folder.

Files who's name start with "Athena" are reserved for use by Orion. Do not edit these files as upgrades to Orion may overwrite them. It is permissible to copy these files and edit the copies.

Fields

Name

Value Type

Description

ConfigName

String

A unique name given to this View Configuration.

Names beginning with "Athena" are reserved for use by Orion.

ViewDefinitions

List of Dictionaries of name value pairs.

Lists the View Definitions to show.

Each dictionary in the list must have one attribute with name "DefinitionName". The value is a string, the name from a View Definition.

Optionally is a attribute with name "Duration". The value is an integer representing the number of seconds to show the View Definition before switching.

 

At most 8 View Definitions may be included. More than 8 are ignored.

MarqueeMessages

List of Dictionaries of name value pairs

Lists the messages to display in the Marquee.

Each dictionary in the list must have one attribute with name "Message". The value is a string, the message is display.

Optionally is a attribute with name "Duration". The value is an integer representing the number of seconds to show the marquee message.

Message strings that include the value {MatchName}, {RelayName}, {Relay} will have the actual name of the match replaced.

At most 8 Marquee Messages may be included. More than 8 are ignored.

Description

String

A brief human-readable description of the View Configuration contents

Example

{

    "ConfigName": "AthenaQualificationPostEvent",

    "ViewDefinitions": [

        {

            "DefinitionName": "AthenaResultListFull",

            "Duration" : 60

        },

        {

            "DefinitionName": "AthenaImageDisplay"

        }

    ],

    "MarqueeMessages": [

        {

            "Message": "THANK YOU FOR COMING TO THE {MatchName}",

            "Duration" : 300

        }

    ],

    "Description": "Alternates between full resultlist and image display; displays thank you for coming message on marquee"

}