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

# Configuration

***

**Configuration** All configuration lives in `config.lua`.

**Core Options**

| Option                | Description                                            |
| --------------------- | ------------------------------------------------------ |
| `Config.Framework`    | Set to `esx` or `qbcore` depending on your server      |
| `Config.PoliceJob`    | Job name for active duty officers                      |
| `Config.OffDutyJob`   | Job name assigned when an officer clocks out           |
| `Config.TextUI`       | Set to `Qs_TextUI` or your preferred TextUI resource   |
| `Config.InteractDist` | Distance in metres to trigger zone interactions        |
| `Config.Webhook`      | Paste your Discord webhook URL here for action logging |

**Keybinds**

| Option                    | Default | Description                   |
| ------------------------- | ------- | ----------------------------- |
| `Config.Keys.PoliceMenu`  | `F6`    | Open the police menu          |
| `Config.Keys.Handcuff`    | `G`     | Quick handcuff nearest player |
| `Config.Keys.QuickEscort` | `H`     | Quick escort nearest player   |
| `Config.Keys.EscortStop`  | `J`     | Stop escorting                |
| `Config.Keys.Tackle`      | `B`     | Tackle nearest player         |

**Jail**

| Option                    | Description                                    |
| ------------------------- | ---------------------------------------------- |
| `Config.Jail.location`    | vector3 coordinates of the jail cell           |
| `Config.Jail.minTime`     | Minimum jail time in minutes                   |
| `Config.Jail.maxTime`     | Maximum jail time in minutes                   |
| `Config.release.location` | vector3 coordinates where players are released |

**Tackle**

| Option                   | Description                               |
| ------------------------ | ----------------------------------------- |
| `Config.Tackle.enabled`  | Enable or disable the tackle system       |
| `Config.Tackle.cooldown` | Cooldown in milliseconds between tackles  |
| `Config.Tackle.distance` | Max distance in metres to tackle a player |

**Microscope**

| Option                            | Description                           |
| --------------------------------- | ------------------------------------- |
| `Config.Microscope.fuelPerUse`    | Fuel consumed per analysis            |
| `Config.Microscope.maxFuel`       | Maximum fuel capacity                 |
| `Config.Microscope.degradePerUse` | Condition lost per analysis           |
| `Config.Microscope.minCondition`  | Minimum condition required to analyze |

**Adding Police Stations** Each station supports independent zone coordinates for boss menu, locker, armory, evidence, and vehicle garage. Add additional stations by copying the existing entry in `Config.Stations`:

lua

```lua
{
    name = 'Sandy Shores PD',
    blip = {
        coords = vector3(x, y, z),
        sprite = 60,
        color  = 29,
        scale  = 0.8,
    },
    zones = {
        boss     = { coords = vector3(x, y, z), radius = 2.0, minGrade = 4 },
        locker   = { coords = vector3(x, y, z), radius = 2.5 },
        armory   = { coords = vector3(x, y, z), radius = 2.0 },
        evidence = { coords = vector3(x, y, z), radius = 2.5, minGrade = 1 },
        vehicles = { coords = vector3(x, y, z), spawn = vector3(x, y, z), heading = 0.0, radius = 3.0 },
    },
}
```

**Adding Fines**

lua

```lua
{ label = 'Your Offence', price = 1000 },
```

**Adding Weapons**

lua

```lua
{ label = 'SMG', weapon = 'WEAPON_SMG', price = 1500, minGrade = 2 },
```

**Adding Vehicles**

lua

```lua
{ label = 'Police Buffalo', model = 'policeb3', grade = 1 },
```

**Adding Uniforms** Find the correct ped component values using a clothing tool then add to `Config.Uniforms.male` or `Config.Uniforms.female`:

lua

```lua
{ label = 'Detective', grade = 3, outfit = {
    tshirt_1 = 15, tshirt_2 = 0,
    torso_1  = 55, torso_2  = 0,
    pants_1  = 25, pants_2  = 0,
    shoes_1  = 10, shoes_2  = 0,
}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://quannsstudios.gitbook.io/quannsstudio-docs/policesystem/configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.