Brick Status configuration

Brick Status has separate bot and FiveM configuration files. Restart the affected service after editing either file.

Bot configuration

config.js owns:

• the FXServer HTTP endpoint and optional display name;
• the public cfx.re join URL;
• whitelist mode and player-facing rejection messages;
• embed branding, description, colors, images, and footer;
• up to five total Discord message buttons.

A configured Connect button counts toward Discord’s five-button limit. Link buttons require HTTP or HTTPS URLs.

Whitelist modes

Set whitelist.mode in config.js:

Mode	Behavior
disabled	Every connection is allowed by Brick Status.
discordMember	The player’s linked Discord account must belong to the configured guild.
discordRoles	The player must belong to the guild and have at least one configured role ID.

Then enable the FiveM side in fivem/brick_status/config.lua:

Config.Whitelist.Enabled = true

Enable or disable both sides together. With bot whitelist mode disabled, the localhost listener is not opened.

Players must have Discord linked to FiveM so FXServer provides a discord: identifier. If the local bot cannot answer within ten seconds, connection enforcement fails closed with the localized unavailable message.

Rich Presence

Rich Presence runs entirely through FiveM client natives. Configure fivem/brick_status/config.lua:

Config.RichPresence = {
    Enabled = true,
    ApplicationId = 'YOUR_DISCORD_APPLICATION_ID',
    Text = 'Players: {players}/{maxPlayers}',
    MaxPlayers = 48,
    LargeAsset = 'server_logo',
    LargeAssetText = 'Join our FiveM community',
    SmallAsset = '',
    SmallAssetText = '',
    Buttons = {
        { Label = 'Connect', Url = 'https://cfx.re/join/abc123' },
        { Label = 'Discord', Url = 'https://discord.gg/example' },
    },
}

Asset keys must exactly match assets uploaded in the Discord Developer Portal. Rich Presence supports at most two HTTPS buttons.

Verification

npm run check
npm test

These commands verify JavaScript/configuration and deterministic status/message/whitelist behavior. They do not authenticate to Discord, connect a FiveM client, render Rich Presence, or test a live player.