> For the complete documentation index, see [llms.txt](https://sbscripts.gitbook.io/sb-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sbscripts.gitbook.io/sb-scripts/sb-scoreboard/configuration.md).

# Configuration

All main settings are in `config.lua`.

| Setting                 | What it does                                                                        |
| ----------------------- | ----------------------------------------------------------------------------------- |
| `Config.Framework`      | `'qbcore'` or `'esx'`.                                                              |
| `Config.Theme`          | `'default'`, `'midnight'`, `'crimson'`, `'emerald'` or `'violet'`. See Themes.      |
| `Config.Logo`           | Logo file and position: `top-left`, `top-center` or `top-right`. Can be turned off. |
| `Config.ShowServerName` | Shows or hides the server name in the header, separately from the logo.             |
| `Config.ShowPing`       | Hides or shows other players' pings. Your own ping always shows.                    |
| `Config.NameType`       | Join name (Steam or Rockstar name) or character name.                               |
| `Config.ShowJob`        | Shows or hides each player's job in the list.                                       |
| `Config.ShowActiveJobs` | Shows or hides the whole Active Jobs panel.                                         |
| `Config.Jobs`           | Job groups for the Active Jobs panel. See Job Groups.                               |
| `Config.DiscordAvatars` | Discord avatars in the player list, through a bot token.                            |

### Keybind and command

The scoreboard opens with `/scoreboard` and a rebindable key, which defaults to `HOME`. The same key closes it while it's open, the same as Escape.

### Admin detection

Staff are detected through your framework's permissions. On QBCore this uses `QBCore.Functions.HasPermission`, and on ESX it uses the player's group. The check lives in `Framework.Server.IsStaff(src)` in `server/server.lua`. Adjust it if your permission setup is different.

### Secrets

The Discord bot token is set in `Config.DiscordAvatars.botToken`. Keep it on the server side and don't share it. The bot doesn't need to be in your server and doesn't need any privileged intents.

### Debug mode

Debug mode spoofs players so you can test the layout without real players online. It lives in `client/client.lua`, not `config.lua`, so it can't end up in a production config by accident. Set `Debug.enabled = false` before going live.