⚙️CONFIGURATION GUIDE

The main configuration is handled in shared/config.lua. Below is a breakdown of every section and variable.

🔧 GENERAL SETTINGS

Variable	Description	Example
Config.ServerName	Display name for your server	"C2 Roleplay"
Config.Framework	Framework type (QBCore, ESX, or QBox)	"QBCore"
Config.OpenKey	Key to open the scoreboard	"F10"
Config.CloseKey	Key to close (ESC by default)	322
Config.BotToken	Discord bot token for fetching avatars (keep private!)	"YOUR_DISCORD_BOT_TOKEN"
Config.SteamAPIKey	Steam API key for Steam avatars (keep private!)	"YOUR_STEAM_API_KEY"
Config.AvatarSource	Choose avatar source (discord, steam, default, none)	"discord"
Config.DefaultAvatar	Path for default image if no avatar found	"./assert/defaultavatar.png"
Config.PlayerListEnable	Enable or disable player list panel	true
Config.MaxPlayers	Maximum player count displayed	200

---

💰 ROBBERIES CONFIGURATION

Control which robberies are shown, how many police are required, and what text or image appears.

Control which robberies are shown, how many police are required, and what text or image appears.

Each robbery has:

• enabled → true/false

• required → number of police required

• Job → job name used to check requirements

• unlockedText / lockedText → messages shown to players

• URL → image path or web URL for display

Example:

["fleeca"] = {
    enabled = true,
    required = 3,
    Job = "police",
    unlockedText = "Ready to hit the store! Stay quick and alert.",
    lockedText = "At least 3 police officers must be online to rob this bank.",
    URL = "./assert/robbery_bank.png"
}

💡 Tip: You can use local images (in the nui/assert/ folder) or external URLs.

---

🧱 JOB CONFIGURATION

Define which jobs appear on the scoreboard and link them with map coordinates.

Each job includes:

• label → friendly display name

• name → framework job name

• URL → image to represent the job

• coords → map position for job location button

Example:

["police"] = {
    label = "LSPD",
    name = "police",
    URL = "./assert/job_police.png",
    coords = { x = 441.2, y = -981.9 }
}

Add as many jobs as you wish — they will automatically display in the Job Activity Panel.

⚠️ Important: ox_lib must be started before c2_scoreboard for the resource to function correctly.

---

🚀 COMMANDS & SHORTCUTS

Action	Default Key
Open scoreboard	F10
Close scoreboard	ESC (322)