Skip to main content

Menu Pages

Gallery, rules, controls, links and loading progress settings.

This section

Menu Pages

OptionDefaultDescription
enabledtrueOff hides the gallery and its button
images9 samplesThe pictures, in order; the first three are fanned out of the button. Up to about 30 stays comfortable
dim0.8How dark the screen behind the open gallery gets, 0.3–0.95

Rules — Config.rules​

OptionDefaultDescription
enabledtrueOff hides the button
sections4 samplesEach a title with its own rules list. At most 10 headings of 40 rules
dim0.88How dark the screen behind the open page gets, 0.7–0.97
lua
sections = {
{ title = 'General', rules = { 'Respect every player.', 'One account per player.' } },
},

Controls — Config.controls​

OptionDefaultDescription
enabledtrueOff hides the button
keys18 samplesYour bound keys, at most 120
commands11 samplesYour chat commands, at most 120
dim0.9How dark the screen behind the open page gets, 0.7–0.97

Both lists take a short or a long form:

lua
keys = {
{ 'F1', 'Opens your phone' },
{ 'ALT + E', 'Opens the vehicle boot' },
{ key = 'MOUSE 3', label = 'Talks on the radio while held' },
},
commands = {
{ '/report', 'Messages the staff on duty' },
},

Write a key the way you say it: 'F1', 'TAB', 'ALT + E', 'NUMPAD 5', 'NUM +'. The number pad is only drawn when something is bound to it, and anything that is not on a keyboard ('MOUSE 3') gets a key of its own under the board.

OptionDefaultDescription
enabledtrueOff hides the links
items3 samplesYour links from left to right, at most 8
discordInfotrueA community server invite shows that server's own name and picture, read live from the invite
discordCountstrue…and how many members it has and how many are online. Off keeps the name and picture
brandColorstrueIcons light up in their platform's colour. Off uses the accent colour

A bare address is enough; everything else is optional:

lua
items = {
'https://your-community-invite',
{ url = 'https://your-store.com', type = 'store', label = 'Our store', description = 'Support the server' },
},
FieldDescription
urlThe address to open
typeWhich icon to use. Recognised platforms are detected from the address; 'store' and 'website' can be set for anything else (full list in shared/config.lua)
labelThe name on the card
descriptionThe line under the name
iconA picture of your own instead of the built-in icon
colorThe colour the icon lights up in

Loading Progress — Config.progress​

OptionDefaultDescription
enabledtrueThe line of light along the bottom edge with the percentage
showStagetrueName the stage the game is at. The names are in the locale file
showPercenttrueShow the percentage