> For the complete documentation index, see [llms.txt](https://docs.northscripts.dev/site/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.northscripts.dev/site/documentation/resources/bossmenu/configuration.md).

# Configuration

All options live in `config/config.lua`. This file is not escrowed.

### General

| Option        | Default     | Description                                                                         |
| ------------- | ----------- | ----------------------------------------------------------------------------------- |
| `Locale`      | `'en'`      | Language for notifications and prompts: `en`, `it`, `fr`, `de`, `es`, `pt-br`, `cs` |
| `Debug`       | `false`     | Extra console output                                                                |
| `Framework`   | `'auto'`    | `esx`, `qbcore` or `qbox` to skip detection                                         |
| `Inventory`   | `'auto'`    | `ox_inventory`, `qb`, `esx` or `standalone`                                         |
| `Target`      | `'auto'`    | `ox_target`, `qb_target` or `none`                                                  |
| `Bank`        | `'auto'`    | `esx_addonaccount`, `renewed_banking`, `qb_banking` or `fallback`                   |
| `AccentColor` | `'#D9FD05'` | Default interface colour, hex. Each player can pick their own in Settings           |

### Limits

| Option            | Default  | Description                              |
| ----------------- | -------- | ---------------------------------------- |
| `MaxGrades`       | `15`     | Most grades a job can have               |
| `MaxSalary`       | `10000`  | Highest salary a boss can set on a grade |
| `MaxStashes`      | `5`      | Stashes per job                          |
| `MaxWardrobes`    | `5`      | Wardrobes per job                        |
| `Stash.Slots`     | `50`     | Slots per stash                          |
| `Stash.MaxWeight` | `100000` | Weight per stash                         |

> Set `MaxSalary` to match your economy. A boss chooses the salary of every grade in their job, including their own.

### Behaviour

| Option              | Default  | Description                                                                                                              |
| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `LiveJobManagement` | `true`   | Bosses can add, rename, delete and reorder grades and change salaries. With `false` they can only edit grade permissions |
| `BossGradeName`     | `'boss'` | On a job with a single grade, the menu is only available if that grade has this name                                     |
| `RequireDuty`       | `true`   | Players must be on duty to open the menu, a stash or a wardrobe. The duty point always works                             |

### Placement and markers

| Option          | Description                                                                                                                    |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `PlacementKeys` | [Control ids](https://docs.fivem.net/docs/game-references/controls/) used while placing a point                                |
| `Marker.Types`  | [Marker types](https://docs.fivem.net/docs/game-references/markers/) to cycle through with Q / E. The first one is the default |
| `Marker.Size`   | `{ x, y, z }` scale                                                                                                            |
| `Marker.Color`  | `{ r, g, b, a }`                                                                                                               |

### Per-job overrides

Limits can be changed for single jobs. Add this at the bottom of `config/config.lua`:

```lua
Config.Jobs = {
    police = {
        MaxStashes = 10,
        Stash = { Slots = 100, MaxWeight = 250000 },
    },
    mechanic = {
        MaxGrades = 6,
    },
}
```

Supported keys: `MaxGrades`, `MaxStashes`, `MaxWardrobes`, `Stash`.