Configuration

All customisation lives in two files:

• shared/brand.lua — server branding (name, version, language, colour).
• config.lua — which shards are active and general options.

Branding (shared/brand.lua)

Brand = {
  serverName = 'FiveRank',     -- shown in the deck header
  version    = '1.6.9',        -- version pill visible in the UI
  locale     = 'en',           -- default language: es | en | pt | fr | de
  accent     = '#c9a961',      -- accent colour (any hex)
  logoUrl    = '',             -- optional: absolute URL to the server logo
}

Active shards (config.lua)

Shards are the "sections" of the deck. The 8 default shards are:

Shard	Function
hub	Welcome screen with status summary and quick-access buttons.
profile	Character identity: name, job, gang and framework stats.
server	Server info from fiverank.gg: players, ranking, votes, followers.
social	Friends you follow on FiveRank who are connected right now.
support	In-game support tickets managed by your staff from fiverank.gg.
podium	Real-time server leaderboard with the top players.
settings	UI sounds, volume and menu language.
system	Change character, disconnect, quit game.

Enable, disable or reorder each one via Config.Shards in config.lua.

Contextual shards (automatic)

Beyond the 8 above, Config.Contextual adds extra panels based on player state:

Config.Contextual = {
  vehicle = true,  -- behind the wheel: plate, fuel, engine, chassis
  combat  = true,  -- while taking damage: tactical status
}

Control freeze

Config.FreezeControls = true  -- freezes controls while the deck is open

Help buttons

Config.HelpButtons = {
  { label = 'Rules',   action = 'url',     value = 'https://...' },
  { label = 'Discord', action = 'url',     value = 'https://...' },
  { label = 'Report',  action = 'command', value = '/report' },
}

FiveRank integration (optional)

To activate the Server, Social, Podium shards and fame / ranking / vote data, link your server at fiverank.gg and add your token to the server:

set fiverank_token "frk_live_..."

The resource reuses the token from fiverank_guard if you already have it configured. API communication is performed exclusively server-side (server/fiverank_api.lua), with no secrets exposed to the client.

Without a token, those shards display a "Link your Discord on fiverank.gg to see it here" message and the rest of the deck works normally.

Next step

→ Languages