Configuration

The config.json sections that control branding, panel toggles, loading timings, text, background and music.

On this page6

Branding
Toggles
Loading
Locales
Background
Music

Branding

Key	What it does
`ServerName`	The full-screen title in act one of the intro
`LogoUrl`	Used for the intro logo reveal and the logo on the finished screen. Must be a URL the client can reach. Blank skips both
`LogoSize`	Height of the centre logo in `vh`. Does not affect the intro reveal
`ThemeColor`	Hex accent colour. Tints nav labels, panel borders, the progress bar and key caps

ThemeColor also drives text colour, so keep it light. A dark value makes the interface unreadable against the black backdrop.

Toggles

Key	What it does
`EnableIntro`	Master switch for the opening overture
`EnableIntroText`	Act one, the full-screen `ServerName`
`EnableIntroLogo`	Act two, the logo reveal. Also needs a non-empty `Branding.LogoUrl`
`EnableMusic`	The music player
`EnableNews`	The news nav entry and panel
`EnableKeybinds`	The keybinds nav entry and panel
`EnableStaff`	The staff nav entry and panel
`EnableGallery`	The gallery nav entry and panel
`EnableSocials`	The social icon row
`EnableDiscordContext`	The Discord profile badge

The two act flags only matter while EnableIntro is true.

Loading

Read by client/main.lua only. Each value must be a number of 0 or more.

Key	What it does
`MinDisplayMs`	How long the screen stays up. The screen is dismissed once the session has started and this has elapsed
`FadeOutMs`	Length of the fade to black on the way out
`ReadyGraceMs`	Settle time after the session starts
`SafetyTimeoutMs`	Hard cap. The screen always dies by this point

Intro acts playing	Cap applied
Text and logo	`16000`
Text only	`11000`
Logo only	`9000`
Neither	`3000`

The cap only ever lowers the value. An explicit shutdown request from another resource bypasses MinDisplayMs entirely.

Locales

Key	What it does
`NavKeybinds`	Nav label for the keybinds panel
`NavStaff`	Nav label for the staff panel
`NavNews`	Nav label for the news panel
`NavGallery`	Nav label for the gallery panel
`KeybindsHeading`	Heading inside the keybinds panel
`StaffHeading`	Heading inside the staff panel
`LatestUpdates`	Heading inside the news panel
`CapturedMoments`	Heading inside the gallery panel

The four panel headings render with the first word emphasised, split at the first space. Keep all eight short or they will crowd the panel on smaller viewports.

Background

Key	What it does
`Type`	`"gallery"` for an image rotation, `"video"` for a looping clip. Any other value renders no background
`VideoUrl`	Used when `Type` is `"video"`
`GalleryInterval`	Milliseconds each image is held before the next fades in
`Images`	Used when `Type` is `"gallery"`

A single image renders as a static backdrop. In video mode a YouTube link plays through YouTube's iframe player; any other URL must be something the embedded browser can decode, such as an H.264 MP4.

json

"Background": {
    "Type": "gallery",
    "GalleryInterval": 5000,
    "Images": [
        "https://your-cdn.com/bg1.png",
        "https://your-cdn.com/bg2.png"
    ]
}

Nothing here is bundled. Every image, clip and logo is fetched over the network by a client that is still connecting, so host them on a CDN and keep file sizes modest. A background that has not arrived is a black screen.

Music

Key	What it does
`Playlist`	Array of `{ "Title", "Url" }`. Tracks play in order and wrap round
`Volume`	Starting volume, `0` to `1`
`MutedByDefault`	Starts muted. The track still runs

Url must be a direct link to an audio file, such as an .mp3 on a CDN.

json

"Music": {
    "Playlist": [
        { "Title": "Track Name", "Url": "https://your-cdn.com/track.mp3" }
    ],
    "Volume": 0.25,
    "MutedByDefault": false
}

Volume is read with a falsy check, so 0 is treated as unset and becomes 0.3. Use MutedByDefault, or a small value such as 0.05, to start quiet.

Extra ConfigurationThe content arrays in config.json, handing the shutdown to your framework.