> For the complete documentation index, see [llms.txt](https://wiki.qfdevelopers.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.qfdevelopers.com/scripts/editor-18/configuration.md).

# Configuration

## Languages

You can set the language of the script in the configuration file.

* `en`: English
* `fr`: French
* `pl`: Polish
* `de`: German
* `es`: Spanish

<figure><img src="/files/ig9o7wm8oX8fWWbPFHXs" alt=""><figcaption></figcaption></figure>

## Society

Defines the society settings used for billing and fine distribution.

* `name`: Society account name used for transactions.
* `jobname`: Job identifier that will access the system.
* `label`: Display name of the organization.
* `percentToBoss`: Percentage of the fine that goes to the society account.
* `percentToWorker`: Percentage of the fine paid directly to the officer.

<figure><img src="/files/cqSA1oVPcCfKfIxqLeBk" alt=""><figcaption></figcaption></figure>

## Billings

Enables integration with external billing systems.\
Set the desired system to `true` to allow fines and charges to be processed through that billing resource. Only one billing system should be enabled at a time to avoid conflicts.

<figure><img src="/files/qkDrsBdr8CtsW3G9o6IM" alt=""><figcaption></figcaption></figure>

## Banks

Selects the banking system used for processing payments.\
Set the appropriate option to `true` to enable compatibility with your server's banking resource.\
Only one banking system should be enabled at a time.

<figure><img src="/files/posm6LkEt7MIFvfxVXqM" alt=""><figcaption></figcaption></figure>

## Phones

Specifies the in-game phone system used for sending notifications and alerts.\
Set the matching phone resource to `true` to enable integration.\
Only one phone system should be active at a time.

<figure><img src="/files/IFCQ7r6fIceWzoFQTfQ4" alt=""><figcaption></figcaption></figure>

## Licenses

Determines which license system is used for managing player licenses (e.g., driving, weapon).\
Set the appropriate license system to `true` based on your server's framework.\
Only one license system should be enabled at a time.

<figure><img src="/files/RXBcjuPdPO0SHAyGYcJf" alt=""><figcaption></figcaption></figure>

## Max Distance to Jail or Fine

Defines the maximum distance (in meters) between the officer and the suspect required to issue a jail sentence or fine. If the suspect is farther than this value, the action will be blocked.

<figure><img src="/files/wMuX0hHvxMO9Az6pjoOK" alt=""><figcaption></figcaption></figure>

## Show

Controls the visibility of specific UI elements and features:

* `Radio`: Shows the player's radio channel.
* `Nearest`: Displays the nearest players in the MDT.
* `BadgeSystem`: Enables integration with a badge/ID system (if available).

<figure><img src="/files/4JYV5ywyUQmtlfJIsrsS" alt=""><figcaption></figcaption></figure>

## Using Radio

Specifies which radio system is used for displaying the player's active radio channel.\
Set the radio system your server uses to `true` (e.g., `pma_voice`).\
Only one radio integration should be enabled.

<figure><img src="/files/Nunm0cbOIOAWNetZfjTW" alt=""><figcaption></figcaption></figure>

## Jobs

Defines job-related permissions and behavior for accessing and managing the MDT system:

* `OneJob`: If `true`, each job has its own separate reports and dispatches. If `false`, all authorized jobs share the same system.
* `OnDuty`: List of job names allowed to access the MDT (e.g., `'police'`).
* `KickDuty`: Settings applied when a player is removed from duty:
  * `name`: Job to assign after being kicked from duty.
  * `data`: Controls how the grade is set (new grade, same grade, etc.).
* `AccessToManagementFunctions.fromGrade`: Minimum job grade required to access management features.
* `CityStatus.Message`: Enables city-wide announcement events with a customizable prefix and icon.
* `ShowHours`: If `true`, shows officers' total service hours in the MDT.
* `ShowFines`: If `true`, enables the fines system in the MDT.
* `BlockProfiles`, `ResetHours`, `AddRemoveLicense`: Minimum job grades required to block profiles, reset duty hours, or manage licenses.

<figure><img src="/files/RzelCvYpEMajo5THURqs" alt=""><figcaption></figcaption></figure>

## Message Colors

Defines RGB color codes used for different types of messages or alerts in the MDT Dispatch:

* `BlackCode`: Default or neutral messages.
* `RedCode`: Critical or high-priority alerts.
* `OrangeCode`: Warnings or medium-priority events.
* `GreenCode`: Informational or low-priority notifications.

<figure><img src="/files/3mwavSo6Z3sjktLOJYkY" alt=""><figcaption></figcaption></figure>

## ToggleMDT

Configures how players can open the MDT interface:

* `key`: Default keybind assigned to open the MDT (can be changed by the player in GTA settings).
* `commandName`: Chat command that gets triggered by the keybind.
* `keymappingLabel`: Label shown in GTA V settings under **Key Bindings > FiveM**, allowing players to rebind the key.

<figure><img src="/files/nAUyRMDcHPfCI6OuqXQH" alt=""><figcaption></figcaption></figure>

## Properties

Enables compatibility with housing and property systems used on your server.\
Set the corresponding option to `true` based on the property resource you use (e.g., `qs_housing`, `esx_property_legacy`, `qb_apartments`, etc.). Only enable the one that matches your server setup to ensure correct address detection and property integration in the MDT.

<figure><img src="/files/k0fnriYgcXPgkGymofov" alt=""><figcaption></figcaption></figure>

## Jails

Defines which jail system is used for handling arrests through the MDT.\
Set the jail system used on your server to `true` (only one should be enabled at a time). Some systems, like `pickle_prisons`, may require an additional jail name (e.g., `pickle_prisons_jailName = "default"`).

<figure><img src="/files/QdssIcURTYfd0oDkWdHg" alt=""><figcaption></figcaption></figure>

## Gender Table

Configures how the script reads player gender from your database (for ESX-based servers only).

* `sqlUserName`: The column name in your `users` table that stores gender information (e.g., `'sex'` or `'gender'`).
* `sqlNames`: Maps gender values from your database to standard terms:
  * `'male'`: Value used to represent male players (e.g., `'m'`, `1`, etc.).
  * `'female'`: Value used to represent female players (e.g., `'f'`, `0`, etc.).

> **Note:** This section is not required if you're using **QBCore**, as gender is handled differently.

<figure><img src="/files/ZRH2Y5yjKDHHFZ3KbSzi" alt=""><figcaption></figcaption></figure>

## Citizens Licenses

Defines how player licenses are displayed in the MDT (e.g., driving or weapon licenses).\
Each entry represents one license type pulled from your database.

* `sqlName`: The name of the license in your database (e.g., `'drive'`, `'weapon'`).
* `isText`: Set to `true` to display the license as text (e.g., `"A"`, `"B"`), or `false` to show it as an icon.
* `translateLicense`: Text label shown if `isText` is `true` (e.g., `"A"` for motorcycle). Leave empty if using an icon.
* `licenseIcon`: Font Awesome icon name used if `isText` is `false`. Leave empty when using text.\
  → Browse available icons here: <https://fontawesome.com/icons>

> You can freely customize this list to match your license structure (e.g., weapon permits, truck licenses, etc.).

<figure><img src="/files/zZYIX6gvYAPCC2ksDNcw" alt=""><figcaption></figcaption></figure>

## Navigation bar

Controls the visibility of navigation tabs in the MDT interface.\
Set each option to `true` to show the corresponding section or `false` to hide it.

* `home`: Main dashboard
* `annoucements`: Internal police announcements
* `files`: Case and report management
* `sep_files`: Separate files tab (if needed for custom setups)
* `police_list`: List of active officers
* `house_list`: Property and address records
* `radio_codes`: List of radio/code signals
* `warrants`: Active warrants database
* `evidences`: Evidence tracking and storage
* `notifications`: Internal system notifications
* `dispatch`: Dispatch alert system
* `customcars`: Custom vehicle database (if used on server)

<figure><img src="/files/fljuxOJz4g8Sz1RviGxw" alt=""><figcaption></figcaption></figure>

## Dispatch - Basic configuration

Configures integration with external dispatch systems.\
Set the dispatch system used on your server to `true` (e.g., `qf_dispatch`, `cd_dispatch`, `linden_dispatch`, etc.).\
Only one dispatch integration should be active at a time.

* `notif_dispatch`: Enables native MDT dispatch alerts using `TriggerClientEvent(...)` with full customization (title, subtitle, code, color, and responder limit).
* `IgnoredJobs`: List of jobs that should not receive dispatch alerts from this system.

<figure><img src="/files/cftOw2ayetuWwZ6rjtXw" alt=""><figcaption></figcaption></figure>

## Dispatch - Alerts

You can trigger a dispatch alert in the MDT either from the **client-side** or **server-side**.\
For better security and control, we recommend using the **server-side** method.<br>

* `coords`: Vector3 or table with x, y, z
* `'title'`: Main alert text
* `'subtitle'`: Additional context
* `'code'`: Optional call code (e.g., `10-90`)
* `'rgb(r, g, b)'`: Color of the alert
* `10`: Max number of players who can respond (set to `0` to disable limit)<br>

### Server-Side to Client-Side

<figure><img src="/files/KioK4hRrTjhG2XNXO9m6" alt=""><figcaption></figcaption></figure>

### Client-Side to Server-Side

<figure><img src="/files/jpCZgrnJNk4wH1h5hAaU" alt=""><figcaption></figcaption></figure>

## Dispatch - Notify alerts

Enables visual notifications for dispatch alerts. When set to `true`, players will receive a top-right notification whenever a new alert is added to the MDT.

<figure><img src="/files/niXsKpoK4a0s6OQVjz3x" alt=""><figcaption></figcaption></figure>

## Dispatch - Defaults & Blacklist

* `DefaultAlertsDelay`: Sets the delay (in seconds) between repeated automatic alerts to avoid spam.
* `DefaultAlerts`: Enables or disables predefined automatic alerts such as:
  * `'Speeding'`: Vehicle speeding detection
  * `'Shooting'`: Gunfire detection
  * `'Autotheft'`: Vehicle theft
  * `'Melee'`: Melee combat detection
  * `'PlayerDowned'`: Player down or incapacitated
* `WeaponBlacklist`: List of weapons that are ignored by the automatic shooting alert system (e.g., snowballs, stun guns, grenades).\
  Useful for preventing non-lethal or non-threatening items from triggering dispatch alerts.

<figure><img src="/files/UImlDRt9vBj7jvvmq5cq" alt=""><figcaption></figcaption></figure>

## Dispatch - Sounds

Controls sound notifications when a new dispatch alert is received:

* `Default`: Enables the use of GTA V’s native frontend sound.
  * `frontArgs1` and `frontArgs2` define the specific sound to be played.
  * Set `use` to `true` to activate.
* `Custom`: Allows playing a custom `.ogg` sound file from your `sounds` folder using an external sound system like `InteractSound`.
  * `triggerName`: Name of the client event to play the sound.
  * `fileName`: Name of the sound file (without extension).
  * `volume`: Volume level (e.g., `0.2`).
  * Set `use` to `true` to enable custom sound playback.

<figure><img src="/files/4QWh49hhv1vNyoYxuVWr" alt=""><figcaption></figcaption></figure>

## Dispatch - Colors

Defines the list of vehicle color names used in the MDT when displaying or searching vehicle data.\
Each entry maps a color index (as used in vehicle properties) to its corresponding readable name (e.g., `'0' = "Metallic Black"`). You can freely expand, remove, or modify entries to match your server’s needs or limit the visible palette.

<figure><img src="/files/EnyOTBmm8i5XyI70ukW0" alt=""><figcaption></figcaption></figure>


---

# 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:

```
GET https://wiki.qfdevelopers.com/scripts/editor-18/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
