Info Panels

How It Works

Every entry in Config.Panels becomes a button in the top right of the loading screen. Section buttons open the info panel on that section, and players can switch between sections with the same buttons inside the panel. Link buttons open the page in the player's browser instead.

The panel closes with the X, by clicking outside it or with Esc. The mouse cursor is shown on the loading screen so players can click the buttons.

Config.Panels = {
    { Label = 'Tips', Type = 'tips' },
    {
        Label = 'Staff Team',
        Type = 'staff',
        Members = {
            { Name = 'Pugwugg', Role = 'Management Team', Image = 'staff/pugwugg.png' },
        },
    },
    {
        Label = 'Keybinds',
        Type = 'keybinds',
        Keys = {
            { Key = 'F1', Action = 'Phone' },
            { Key = 'TAB', Action = 'Inventory' },
            { Key = 'LALT', Action = 'Target' },
        },
    },
    { Label = 'Rules', Type = 'link', Url = 'https://example.com/rules' },
    { Label = 'Discord', Type = 'link', Url = 'https://discord.gg/example' },
}

Buttons appear in the order they are listed. Leave Config.Panels empty to hide the buttons entirely.

Section Types

• tips - lists every tip from Config.Tips.
• list - a numbered list from Items, such as rules or an FAQ.
• text - one or more paragraphs from Text.
• staff - staff cards from Members, each with a Name, an optional Role and an optional Image.
• keybinds - a keyboard with each Key in Keys lit up and a line to its Action.
• link - a button that opens Url, which must start with http:// or https://.

A section with a missing label or empty content is skipped instead of breaking the page.

Staff

{
    Label = 'Staff Team',
    Type = 'staff',
    Members = {
        { Name = 'Pugwugg', Role = 'Management Team', Image = 'staff/pugwugg.png' },
        { Name = 'Example', Role = 'Moderator' },
    },
},

Image is a file in the media folder or a full URL. Members without a picture, or whose picture fails to load, show the first letter of their name instead.

Keybinds

{
    Label = 'Keybinds',
    Type = 'keybinds',
    Keys = {
        { Key = 'F1', Action = 'Phone' },
        { Key = 'LALT', Action = 'Target' },
        { Key = 'B', Action = 'Seatbelt' },
    },
},

Keys on the top half of the keyboard are labelled above it and keys on the bottom half below it. Two actions on the same key share one label.

Key names are not case sensitive. Letters, numbers, F1-F12, symbols and the following names all work:

ESC  TAB  CAPS  LSHIFT  RSHIFT  LCTRL  RCTRL  LALT  RALT  SPACE  ENTER  BACKSPACE
INSERT  HOME  PAGEUP  DELETE  END  PAGEDOWN  UP  DOWN  LEFT  RIGHT

SHIFT, CTRL and ALT mean the left-hand key. Keys that are not on the drawn keyboard, such as mouse buttons, are not shown.

Links