Connecting Your Server

The Blaze Companion Resource connects your FiveM server to your website, enabling live player data, server status, and game-specific integrations.

Installation

1. Download the resource

Go to Settings → FiveM Integration in your dashboard and click Download Companion Resource. You'll receive a .zip file called blaze-companion.zip.

2. Extract and install

Extract the zip and place the blaze-companion folder in your server's resources directory:

/resources
  /blaze-companion
    fxmanifest.lua
    config.lua
    /server
      main.lua
      routes.lua

3. Configure

Open config.lua and set your credentials:

Config = {}

-- Required
Config.ApiKey  = "blz_live_xxxxxxxxxxxxxxxxxxxx"
Config.SiteUrl = "https://yourserver.blazesites.net"

-- Optional — fine-tune what data is shared
Config.ShowPlayerList   = true   -- show online players on site
Config.ShowPlayerJobs   = true   -- show character jobs (requires QBCore/ESX)
Config.ShowEconomy      = false  -- show economy data (performance impact)
Config.ShowCharNames    = true   -- show character names instead of Steam names
Config.UpdateInterval   = 30     -- seconds between status updates

4. Add to server.cfg

ensure blaze-companion

5. Restart your server

Start or restart your FiveM server. Within 30 seconds, your Blaze Sites dashboard will show:

● FiveM Connected
Last ping: just now · Players: 14/64

Finding your API key

Your API key is in Settings → FiveM Integration → API Key.

Troubleshooting

Dashboard shows "Disconnected" after restarting:

• Confirm ensure blaze-companion is in your server.cfg
• Confirm Config.ApiKey matches exactly what's shown in your dashboard
• Check your server console for errors from blaze-companion

Player list shows but no job data:

• Set Config.ShowPlayerJobs = true in config.lua
• Make sure QBCore or ESX is running and loaded before blaze-companion

Server shows Online but player count is always 0:

• This can happen if your server uses a non-standard player management resource
• Open a support ticket with your server console output

Disconnecting

To disconnect your server, go to Settings → FiveM Integration → Disconnect Server. This removes the connection but does not uninstall the resource from your server.