stuk-nodecg.json

Schema

• sponsor Object Settings for the sponsor logos and banners that display on the game layouts:

  • fadeInTime Integer The time in milliseconds it takes for a sponsor logo/banner to fade in.

  • dwellTime Integer The time in milliseconds a sponsor logo/banner is displayed for before it starts to fade out.

  • fadeOutTime Integer The time in milliseconds it takes for a sponsor logo/banner to fade out.

• omnibar Object Settings for the Omnibar. See Omnibar for details:

  • tracker String The donation tracker being used. This should be set to tiltify, gdq, or left blank. 

  • marathonName String The name of the marathon.

  • startDate String The start date of the marathon. Must be written as DD Month YYYY.

  • startTime String The start time of the marathon. Must be written in 24-hour format as HH:MM.

  • forCharity Boolean Whether to use charity support tools such as donation totals and charity callouts on the Intermission, Opening, and Closing scenes and the Omnibar. 

  • charityName String The name of the charity being supported.

  • displayURL String The URL to display on the second Omnibar message. If omnibar.forCharity is set to true the message will read "Donate at displayURL". If omnibar.forCharity is set to false the message will read "Check us out at displayURL".

  • currency String The symbol for the currency you're collecting donations in. Will be displayed before any monetary value on display.

  • numRuns Integer The number of upcoming runs to cycle though.

  • numIncentives Integer The number of live incentives to cycle through.

  • numBidwars Integer The number of live bidwars to cycle through.

  • numPrizes Integer The number of live prizes to cycle through.

  • dwellTime Integer The time in milliseconds a message is displayed for before it cycles to the next one. Must be at least 5000.

• timeZone Object Settings for your timezone:

  • continentCity String The timezone identifier. This must be a valid tz identifier; you can find a list of identifiers on Wikipedia.

  • zoneCode String The timezone abbreviation. This is only used for displaying on the omnibar and intermission screen, it can be whatever format you'd prefer.

  • locale String The country language locale code. This determines how dates are displayed (for example a shorthand date in the UK (en_GB) is written as "dd/mm/yy" whilst in the US (en_US) it is written as "mm/dd/yy"). This must be a valid locale code; you can find a list of codes on Saimana.com.

• warningMessage Object Settings for the Warning Message panel:

  • text Array of Strings The warning messages to be made available in the dropdown list on the Warning Message panel. If only one string is included, the dropdown menu is removed and replaced with either a static message or a pre-filled text box depending on the setting of warningMessage.allowEdit.

  • allowEdit Boolean Sets whether users can create custom warnings through the Warning Message panel. This should only be set to true if you fully trust your tech volunteers, as this will give them the freedom to display any message on a game layout. If set to true and only one string is set in warningMessage.text, the Warning Message panel will display an editable text-box prefilled with your warning message and a "Reset" button to revert the message back after editing. If set to false, users will be limited to the strings set in warningMessage.text.

• useRainwaveMusic Boolean Enables the use of the built in Rainwave.cc music player. Setting to true will automatically play music from OverClocked ReMix, and display music credits on the Opening, Close, and Intermission scenes.

• intermissionCam Boolean Enables the webcam area on the Intermission scene, see the Design Variables guide for an example.