Menu Pages
Gallery — Config.gallery
| Option | Default | Description |
|---|---|---|
enabled | true | Off hides the gallery and its button |
images | 9 samples | The pictures, in order; the first three are fanned out of the button. Up to about 30 stays comfortable |
dim | 0.8 | How dark the screen behind the open gallery gets, 0.3–0.95 |
Rules — Config.rules
| Option | Default | Description |
|---|---|---|
enabled | true | Off hides the button |
sections | 4 samples | Each a title with its own rules list. At most 10 headings of 40 rules |
dim | 0.88 | How 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
| Option | Default | Description |
|---|---|---|
enabled | true | Off hides the button |
keys | 18 samples | Your bound keys, at most 120 |
commands | 11 samples | Your chat commands, at most 120 |
dim | 0.9 | How 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.
Links — Config.links
| Option | Default | Description |
|---|---|---|
enabled | true | Off hides the links |
items | 3 samples | Your links from left to right, at most 8 |
discordInfo | true | A community server invite shows that server's own name and picture, read live from the invite |
discordCounts | true | …and how many members it has and how many are online. Off keeps the name and picture |
brandColors | true | Icons 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' },
},
| Field | Description |
|---|---|
url | The address to open |
type | Which 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) |
label | The name on the card |
description | The line under the name |
icon | A picture of your own instead of the built-in icon |
color | The colour the icon lights up in |
Loading Progress — Config.progress
| Option | Default | Description |
|---|---|---|
enabled | true | The line of light along the bottom edge with the percentage |
showStage | true | Name the stage the game is at. The names are in the locale file |
showPercent | true | Show the percentage |
