> 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-illegalcleaner/configuration.md).

# Configuration

Main editable file: **`shared/config.lua`** (open / outside escrow).\
Restart the resource after changes.

### Must-set

| Key           | Example       | Meaning                                    |
| ------------- | ------------- | ------------------------------------------ |
| `Language`    | `'en'`        | UI + notifies language.                    |
| `Core`        | `'auto'`      | `auto` / `esx` / `qb` / `qbox`.            |
| `SQL`         | `'oxmysql'`   | Database driver.                           |
| `Target`      | `'ox_target'` | `ox_target` / `qb-target` / `drawtext`.    |
| `Notify`      | `'ui'`        | Built-in UI notify, or ox\_lib / qb / esx… |
| `VehicleKeys` | `'auto'`      | Key system for the job van.                |

### Party & fail

| Key                         | Default     | Meaning                                                    |
| --------------------------- | ----------- | ---------------------------------------------------------- |
| `EnablePayoutShares`        | `true`      | Leader sets % money split. `false` = everyone full payout. |
| `FailJobOnMemberDisconnect` | `true`      | One member leaves → job fails for all.                     |
| `FailJobFine.enabled`       | `true`      | Take money on fail.                                        |
| `FailJobFine.mode`          | `'percent'` | `percent` or `fixed`.                                      |
| `FailJobFine.percent`       | `25`        | % of payout if percent mode.                               |

### Shells & isolation

| Key                        | Default         | Meaning                                        |
| -------------------------- | --------------- | ---------------------------------------------- |
| `ShellDefaults.enabled`    | `true`          | Shell jobs on/off.                             |
| `ShellDefaults.resource`   | `'qb-interior'` | Rename if your shell resource name differs.    |
| `ShellDefaults.spawnDepth` | `50.0`          | How deep under ground the shell spawns.        |
| `CrimeSceneBucket.enabled` | `true`          | Party goes to private routing bucket on scene. |
| `CrimeSceneBucket.id`      | `7700`          | Base bucket id (`id + partyId`).               |

### Schedule & cooldown (off by default)

| Key                            | Default | Meaning                           |
| ------------------------------ | ------- | --------------------------------- |
| `JobSchedule.enabled`          | `false` | Only allow jobs in a time window. |
| `JobSchedule.useGameTime`      | `true`  | GTA clock vs real server time.    |
| `JobCooldown.enabled`          | `false` | Per-player job cooldown.          |
| `JobCooldown.hoursBetweenJobs` | `5`     | Cooldown window hours.            |
| `JobCooldown.maxJobsPerWindow` | `3`     | Max jobs in that window.          |

### Locations, money, levels

Edit **`shared/locations.lua`**:

* `level` — required cleaner level
* `reward.money` — `min` / `max`
* `reward.exp` — `min` / `max`
* `enabled` — turn a location on/off
* `difficulty` / `timeLimit`

Entrances: **`shared/locationEntrances.lua`**\
Shell models / exits: **`shared/shells.lua`**\
Outfit, van, depot, NPC: **`shared/config.lua`** → `JobOutfit`, `JobVehicle`, `ReturnDepot`, `JobLocations`

### Corpse loot

```lua
CorpseSearch = {
    enabled = true,
    requiredBeforeBagging = true,
    reward = {
        enabled = true,
        blackMoney = false,
        moneyItem = false,
        amount = { min = 100, max = 200 },
    },
}
```

### Vehicle lockpick + police

```lua
DoorLockpick = {
    enabled = true,
    mode = 'auto',
    attempts = 3,
    dispatch = {
        enabled = true,
        chance = 30,
        mode = 'auto',
        policeJobs = { 'police', 'sheriff' },
    },
}
```

### Language

1. Set `Config.Language = 'en'` (or `tr`, `de`…).
2. Matching file in `locales/` is used.
3. Restart resource.

### What you can edit after escrow

Open files include: `shared/*`, `locales/*`, `client/core.lua`, `client/editable/**`, `server/core.lua`, `server/editable/**`, `sql/**`, `data/**`, `dui/**`.

Encrypted (do not expect to edit): main job logic, `client/editable.lua`, `ui/dist`, etc.

Full key-by-key list → see `izzy-illegalcleaner.md`.


---

# 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-illegalcleaner/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.
