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

# Installation & Configuration

***

### Downloading Dependencies

{% stepper %}
{% step %}

### **Oxmysql**

{% embed url="<https://github.com/overextended/oxmysql>" %}
{% endstep %}
{% endstepper %}

**Configuration**

Open `config.lua` and configure the script:

```lua
Config = {}

Config.Framework = 'auto' -- auto / qb / esx / standalone

Config.ServerName = 'iZaap Scripts'
Config.BrandShort = 'IZ'
Config.PlayersLabel = 'Players'

Config.OpenKey = 'F10'
Config.RefreshInterval = 3500
Config.MaxPlayers = tonumber(GetConvar('sv_maxclients', '1024')) or 1024

Config.Accent = '#f8c82c'
Config.DefaultBadgeColor = '#657080'

Config.ShowPlayerNumber = true -- Displays the player's server ID
Config.ShowJob = true -- Displays the player's current job
Config.ShowDuty = true -- Displays duty status. Requires Config.ShowJob = true
Config.ShowPing = true -- Displays the player's current ping

Config.BadgeOrder = {
    'police',
    'ambulance',
    'mechanic',
    'realestate'
}

Config.JobBadges = {
    police = {
        label = 'Police',
        color = '#4b6bff',
        icon = 'fa-solid fa-shield-halved'
    },
    ambulance = {
        label = 'Medics',
        color = '#67c96b',
        icon = 'fa-solid fa-kit-medical'
    },
    mechanic = {
        label = 'Mechanics',
        color = '#f2a93b',
        icon = 'fa-solid fa-wrench'
    },
    realestate = {
        label = 'Real Estate',
        color = '#38bdf8',
        icon = 'fa-solid fa-house'
    }
}
```

***

**Keybind**

Default key:

```shellscript
F10
```

You can change it from `config.lua`:

```lua
Config.OpenKey = 'F10'
```

***

**Job Badges**

You can add, remove or edit job badges from:

```lua
Config.JobBadges = {}
```

Example:

```lua
police = {
    label = 'Police',
    color = '#4b6bff',
    icon = 'fa-solid fa-shield-halved'
}
```

The order of the badges is controlled by:

```lua
Config.BadgeOrder = {
    'police',
    'ambulance',
    'mechanic',
    'realestate'
}
```

***

**Final Check**

* Add `ensure izaap_scoreboard` to your `server.cfg`.
* Configure your framework in `config.lua`.
* Edit server name, brand and player label.
* Configure job badges if needed.
* Press `F10` in-game to open the scoreboard.

***