Skip to main content

Links

Up to 8 link buttons in the top-right corner, with hover cards and live counts for your community server.

This section

Links

Round buttons in the top-right corner, level with the logo: your community, your channels, your social pages, your store or any website.

Features​

  • Up to 8 links, in order from left to right
  • A bare address is enough — the icon, the platform name and the title are worked out from it
  • Hover card — pointing at a link shows what it is and where it goes
  • Live community info — a community server invite shows that server's own name and picture, and how many members it has and how many are online, read live from the invite
  • Brand colours — each icon lights up in its platform's colour when pointed at (or the accent colour for all)
  • Clicking a link opens it in the player's own browser, after the game asks them to confirm

Configuration​

OptionDefaultDescription
Config.links.enabledtrueOff hides the links
Config.links.items3 samplesYour links, at most 8
Config.links.discordInfotrueA community server invite shows that server's name and picture
Config.links.discordCountstrue…and its member and online counts. Off keeps the name and picture
Config.links.brandColorstrueIcons light up in their platform's colour. Off uses the accent
lua
Config.links = {
items = {
'https://your-community-invite',
{ url = 'https://your-store.com', type = 'store', label = 'Our store', description = 'Support the server' },
{ url = 'https://your-website.com', type = 'website', icon = 'media/my-icon.png', color = '#ff6b8b' },
},
}

Every field besides url is optional:

FieldDescription
urlThe address to open
typeWhich icon to use. Recognised platforms are detected from the address; 'store' and 'website' can be set for any other link (the full list is 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