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

# Configuration

### General Settings <a href="#izzy-doj-general-settings" id="izzy-doj-general-settings"></a>

| Property                              | Description                          |
| ------------------------------------- | ------------------------------------ |
| **Config.Debug** (`boolean`)          | Debug mode                           |
| **Config.Framework** (`string`)       | auto, esx, qb                        |
| **Config.Mysql** (`string`)           | oxmysql, mysql-async, ghmattimysql   |
| **Config.Locale** (`string`)          | Locale code                          |
| **Config.openCommand** (`string`)     | Menu open command (example: dojMenu) |
| **Config.Job** (`string`)             | DOJ job name (example: police)       |
| **Config.DefaultActivity** (`string`) | Default activity status              |

### Activity Statuses

Default statuses under Config.ActivityStatuses:

| Property   | Description                  |
| ---------- | ---------------------------- |
| `inactive` | `inactive` - Inactive Status |
| `active`   | `active` - Active Status     |
| `busy`     | `busy` - Busy Status         |
| `away`     | `away` - Away Status         |

### Admin & Rank System

| Property                                | Description                                  |
| --------------------------------------- | -------------------------------------------- |
| **Config.SuperAdmins** (`table`)        | Steam ID list that grants instant SuperAdmin |
| **Config.DefaultRankKey** (`string`)    | Rank key for new players (example: lawyer)   |
| **Config.SuperAdminRankKey** (`string`) | Super admin rank key (example: judge)        |

### Rank Definitions <a href="#izzy-doj-ranks" id="izzy-doj-ranks"></a>

Each Config.Ranks\["rank\_key"] entry defines label and permissions:,

| roperty                            | Description                                                  |
| ---------------------------------- | ------------------------------------------------------------ |
| `label`                            | `label` - Display name                                       |
| `permissions.search`               | `permissions.search` - Citizen/vehicle search                |
| `permissions.mark_wanted`          | `permissions.mark_wanted` - Searching for tags               |
| `permissions.create_note`          | `permissions.create_note` - Note creation                    |
| `permissions.issue_invoice`        | `permissions.issue_invoice` - Invoicing                      |
| `permissions.manage_announcements` | `permissions.manage_announcements` - Announcement management |
| `permissions.manage_ranks`         | `permissions.manage_ranks` - Rank management                 |
| `permissions.fire_employee`        | `permissions.fire_employee` - Dismissal of an employee       |

### Interval Settings (seconds) <a href="#izzy-doj-intervals" id="izzy-doj-intervals"></a>

| Property                | Description                                       |
| ----------------------- | ------------------------------------------------- |
| `ChatMessageCooldown`   | `ChatMessageCooldown` - Chat message cooldown     |
| `CleanupExpiredNotes`   | `CleanupExpiredNotes` - Expired note cleanup      |
| `DatabaseCheck`         | `DatabaseCheck` - Database check                  |
| `MenuOpen`              | `MenuOpen` - Menu open delay                      |
| `RefreshAnnouncements`  | `RefreshAnnouncements` - Announcement refresh     |
| `RefreshVehicleDetails` | `RefreshVehicleDetails` - Vehicle detail refresh  |
| `ActivityCooldown`      | `ActivityCooldown` - Activity change cooldown     |
| `DropdownAnimation`     | `DropdownAnimation` - Dropdown animation duration |

### Vehicle Classes <a href="#izzy-doj-vehicle-classes" id="izzy-doj-vehicle-classes"></a>

Config.VehicleClasses maps GTA5 vehicle class IDs (0-21) to labels.

```lua
Config.Debug = false
Config.Framework = "auto"
Config.Mysql = "oxmysql"
Config.openCommand = "dojMenu"
Config.Job = "police"
Config.DefaultActivity = "inactive"

Config.ActivityStatuses = {
  inactive = "Inactive Status",
  active = "Active Status",
  busy = "Busy Status",
  away = "Away Status"
}
```


---

# 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://izzyshop-1.gitbook.io/izzyshop-docs/izzyshop-resources/izzy-doj/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.