FeaturesPricingIntegrationsCommunityAboutDocs

Docs / FiveM

FiveM Integration

Connect your FiveM server to Docket for live player tracking, whitelist syncing, admin log forwarding, and full QB-Core / vMenu support.

Requirements

  • An active Docket Pro or Enterprise subscription
  • FiveM server with txAdmin or direct server file access
  • QB-Core, vMenu, or a custom framework

Installing the Docket resource

The Docket FiveM resource is a lightweight script that sends data from your game server to your dashboard. It does not modify any gameplay systems.

  1. Go to Dashboard > Integrations > FiveM
  2. Click Generate API Key — copy the key shown
  3. Download the docket-fivem resource from your dashboard
  4. Place the docket-fivem folder in your server's resources directory
  5. Add ensure docket-fivem to your server.cfg
  6. Add your API key to the resource config:
-- docket-fivem/config.lua
Config.ApiKey    = "your-api-key-here"
Config.GuildId   = "your-discord-guild-id"
Config.Framework = "qb-core"  -- "qb-core", "vmenu", or "custom"
  • Restart your server. The dashboard will show a green Connected status within 30 seconds.

    • What gets synced

    DataDescription
    Player countLive count of players online, updated every 30 seconds.
    Player listSteam/Discord IDs of connected players (no personal data).
    Admin logsKicks, bans, warnings forwarded to your dashboard and Discord.
    WhitelistApproved applications automatically whitelist the player's identifier.
    Server uptimeTracks when your server is online and calculates uptime %.

    Whitelist sync

    When a whitelist application is approved in Docket, the member's Discord ID is automatically added to your FiveM server's whitelist. No manual entry needed.

    For QB-Core, this updates the players table flag. For vMenu, it updates the vMenu.Whitelist ace permission. For custom frameworks, Docket calls a configurable export.

    Admin log forwarding

    Admin actions taken in-game (bans, kicks, warnings via txAdmin or native commands) are forwarded to:

    • Your Docket dashboard under Moderation > Admin Logs
    • A designated Discord log channel of your choice

    Set the log channel in Dashboard > Bot Settings > Channels > Admin Logs.

    ← AI PersonalityQB-Core Setup →