Configuration Guide

FS-Bridge Configuration

First, configure your FS-Bridge settings in the config.lua file:

FS = {
    -- Debug settings
    Debug = true,  -- Set to true to enable debug messages in console

    -- Framework integration
    AutoLoadFramework = true,  -- Automatically detect the framework
    Framework = "QBCore",      -- Manual framework selection if AutoLoadFramework is false
                              -- Supported: "QBCore", "ESX", "QBox"

    -- Target integration
    UseTarget = true,         -- Enable target system exports
    AutoLoadTarget = true,    -- Automatically load target exports
    Target = "qb-target",     -- Target resource name if AutoLoadTarget is true

    -- Discord integration
    Token = "YOUR_DISCORD_BOT_TOKEN",  -- Your Discord bot token
}

Important Notes for FS-Bridge

1. Framework Detection

   • AutoLoadFramework = true will automatically detect your framework
   • Set to false to manually specify your framework
   • Supported frameworks: QBCore, ESX, QBox

2. Target System

   • UseTarget = true enables target system integration
   • Supports qb-target and other targeting systems
   • Set AutoLoadTarget = false if you want to manually configure targeting

3. Discord Integration

   • Required for Discord features across all FS resources
   • Bot token must have proper permissions
   • Keep your token secure and never share it

Scoreboard Configuration

Overview

The FS Scoreboard configuration file allows you to customize various aspects of your scoreboard. Below is a detailed explanation of each setting.

Basic Configuration

Config = {
    -- Key to toggle the scoreboard
    -- Default: HOME key (can be changed to any key from https://docs.fivem.net/docs/game-references/controls/)
    ScoreboardKey = "HOME",

    -- Server branding
    ServerName = "Your Server Name",  -- Name displayed at the top of the scoreboard

    -- Player Identification
    Identifier = "license",  -- Options: "steam", "license", "xbl", "live", "discord", "fivem", "license2"
}

Discord Integration

Config = {
    -- Discord features
    UseDiscordNames = true,     -- Show Discord usernames next to player names
    DiscordBotToken = "YOUR_BOT_TOKEN",  -- Required if UseDiscordNames is true
}

Job Display Configuration

Config = {
    -- Job counts display (maximum 3 jobs)
    Jobs = {
        police = {
            name = "LSPD",      -- Display name
            job = "police",      -- ESX job name
            icon = "shield"      -- FontAwesome icon name
        },
        ambulance = {
            name = "EMS",
            job = "ambulance",
            icon = "medkit"
        },
        mechanic = {
            name = "Mechanic",
            job = "mechanic",
            icon = "wrench"
        },
    },
}

Admin Configuration

Config = {
    -- Admin settings
    AdminBadgeIcon = "shield",  -- Icon shown next to admin names
}

Icon Reference

The script uses FontAwesome icons. Here are some commonly used icons:

• shield - For police/admin badges
• medkit - For medical services
• wrench - For mechanical jobs
• car - For vehicle-related jobs
• user - For generic users

Example Complete Configuration

Config = {
    -- Core Settings
    ScoreboardKey = "HOME",
    ServerName = "My FiveM Server",
    Identifier = "license",

    -- Discord Integration
    UseDiscordNames = true,
    DiscordBotToken = "your-token-here",

    -- Job Display
    Jobs = {
        police = {
            name = "LSPD",
            job = "police",
            icon = "shield"
        },
        ambulance = {
            name = "EMS",
            job = "ambulance",
            icon = "medkit"
        },
        mechanic = {
            name = "Mechanic",
            job = "mechanic",
            icon = "wrench"
        },
    },

    -- Admin Settings
    AdminBadgeIcon = "shield",
}

Important Notes

1. Discord Integration

   • If UseDiscordNames is true, make sure your Discord bot token is valid
   • The bot must be in your Discord server
   • Bot requires "Read Members" permission
   • DO NOT GIVE YOUR BOT "ADMINISTRATOR" PERMISSION IF YOU DO SO THE STORE WILL NOT TAKE RESPONSIBILITY

2. Job Configuration

   • Maximum of 3 jobs can be displayed
   • Job names must match your framework jobs
   • Icons must be valid FontAwesome names

3. Performance

   • Discord name fetching is optimized but may cause slight delay on first player join
   • Job counts are updated in real-time

Troubleshooting

If your configuration isn't working:

1. Check for syntax errors (missing commas, brackets)
2. Verify your Discord bot token if using Discord features
3. Ensure job names match exactly with your ESX database
4. Restart the resource after making changes

Need more help? Join our Discord for support!