sg-scoreboard

Overview

A comprehensive scoreboard system for FiveM servers with playtime tracking, rewards system, job monitoring, and heist availability indicators. Now supports both QBCore and Qbox/QBX frameworks!

Features

Framework Compatibility

• QBCore - Full support
• Qbox/QBX - Full support
• Automatic Detection - No manual configuration needed

Dependencies

Installation

Config.Framework = 'auto' -- 'auto', 'qbcore', or 'qbox'
Config.Debug = false -- Enable for debugging

-- '@qbx_core/modules/lib.lua',
-- '@qbx_core/modules/playerdata.lua',

ensure oxmysql
ensure qb-core # or qbx_core for Qbox
ensure ox_lib # Required for Qbox
ensure sg-scoreboard

Configuration

Edit config.lua to customize:

General Settings

Config.KeyBind = "F10" -- Keybind to open scoreboard
Config.Webhook = "your_discord_webhook_url" -- For reward claims
Config.MoneyType = "bank" -- "bank" or "cash" for money rewards

Hidden Players

Config.HiddenLicenses = {
    "license:abc123...", -- Add player licenses to hide their identity
}

Use /getlicense [id] command to get a player's license.

Jobs to Display

Config.Jobs = {
    { job = "police",       label = "Police",        icon = "fas fa-shield-alt" },
    { job = "ambulance",    label = "Ambulance",     icon = "fas fa-ambulance" },
    { type = "mechanic",    label = "Mechanic",      icon = "fas fa-wrench" },
    -- Add more jobs...
}

• - Use job for specific job names
• - Use type for job types (matches multiple jobs)
• - Icons: Use Font Awesome classes (e.g., "fas fa-wrench") or emojis for backward compatibility

Heists

Config.Robberies = {
    { order = 1, label = "Fleeca Bank", icon = "fas fa-university", requiredCops = 3 },
    -- Configure your heists...
}

Icons: Use Font Awesome classes (e.g., "fas fa-university") or emojis for backward compatibility

Rewards/Battlepass

Config.Rewards = {
    { hours = 10,  reward = "R1,500,000", type = "money",   amount = 1500000 },
    { hours = 15,  reward = "Starter Car", type = "vehicle", vehicle = "mk1rabbit" },
    { hours = 200, reward = "IPL House",  type = "house",   houseType = "apartment" },
    -- Add more rewards...
}

Usage

For Players

Open Scoreboard:

• Press F10 (or configured keybind)
• Or use /togglescoreboard command

Tabs:

1. Players - View all online players
2. Jobs - See on-duty job counts
3. Heists - Check heist availability
4. Rewards - View and claim playtime rewards

Theme Toggle:

• - Click the theme toggle button (palette icon) in the header to switch between themes
• - New Theme (Default) - Modern SG-UI styled theme with clean, solid backgrounds
• - Old Theme - Classic theme with background images that change based on the active tab
• - Your theme preference is automatically saved and will be remembered next time you open the scoreboard

Claiming Rewards:

• - Navigate to Rewards tab
• - Green rewards are claimable
• - Yellow rewards are locked (need more playtime)
• - Gray rewards are already claimed
• - Click "CLAIM" button to receive reward

For Admins

Commands:

• /checkplaytime [id] - Check player's playtime (optional id)
• /giveplaytime [id] [hours] - Give playtime to a player (admin only)
• /getlicense [id] - Get player's license for hiding identity (admin only)

Hiding Admin Identity:

1. Get player's license: /getlicense [id]
2. Copy the license from chat/console
3. Add to Config.HiddenLicenses in config.lua
4. Restart script
5. Player will show as "Hidden Identity" on scoreboard

Reward Types

{ hours = 10, reward = "R1,500,000", type = "money", amount = 1500000 }

{ hours = 15, reward = "Starter Car", type = "vehicle", vehicle = "mk1rabbit" }

{ hours = 200, reward = "IPL House", type = "house", houseType = "apartment" }

{ hours = 50, reward = "Special Item", type = "item", item = "special_item" }

Playtime Tracking

Automatic Tracking:

• - Starts when player joins server
• - Saves every 60 seconds
• - Saves on player disconnect
• - Saves on resource stop
• - Persistent across sessions

Stored In:

• - Player metadata: metadata.playtime (in seconds)
• - Player metadata: metadata.claimedRewards (table of claimed reward IDs)

For Testing:

• - Use /giveplaytime [id] [hours] to add playtime
• - Use /checkplaytime [id] to verify playtime

Discord Webhooks

Configure Config.Webhook to receive notifications when players claim rewards:

Notification includes:

• - Player name and Citizen ID
• - Reward type and details
• - Timestamp
• - Vehicle plates (for vehicle rewards)
• - Money amount and account type (for money rewards)