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

# Configuration

Page dedicated to how to configure our Gardener \[V2]

Gardener V2 keeps almost nothing in files. Plots, the depot, the catalog, client briefs, the economy and permissions live in the database and are edited in game in the [Admin Panel](https://wiki.qfdevelopers.com/scripts/gardener-v2/admin-panel.md). The files below only start the resource and connect it to your server, and they all stay open after escrow.

## Languages

The start language is set in `config/config.lua`. After the first start it is changed in **Admin → General** without a restart, together with the accent colour, currency and number format.

* `en`: English
* `pl`: Polish
* `de`: German
* `fr`: French
* `es`: Spanish
* `it`: Italian
* `pt`: Portuguese
* `ja`: Japanese
* `ko`: Korean

The texts are in `config/translations/<code>.lua`. A key missing from a language falls back to English.

### Commands & Keybinds

**Players**

* Interaction key (E): Talk to the foreman, use the locker room, the van ped, the warehouse and every work spot when no target resource is used.
* Tablet (F7): The work tablet with jobs, crew, progress, garden orders and settings.
* Design catalog (F6): Opens the catalog during a design job.

Players change these keys under Settings > Key Bindings > FiveM.

**Design mode**

* Q / E: Rotate the item
* Alt: Fine rotation
* Shift: Snap to the grid
* X: Remove the sketch under the crosshair
* Backspace: Leave design mode

**Admin**

* `/gardenadmin`: Open the admin panel.
* `/gardenadmin tune <kind>`: Play a work animation with its tool and move the tool live (arrows, wheel, Shift, Alt). The values are printed in the F8 console for the `ANIMATIONS` table in `client/editable.lua` (**Base and vehicles** permission).
* `gardenadmin` in the server console: Print the version, framework, target, schema version and whether Banking V2 is connected.
* `gardenadmin import-v1` in the server console: Import levels from V1.

## General

`config/config.lua` holds only what must be known before start:

```lua
Config.Locale = 'en'

Config.Framework = 'auto'
Config.Target = 'auto'
Config.Notify = 'qf'
Config.VehicleKeys = 'auto'

Config.AdminCommand = 'gardenadmin'
Config.AdminAccess = {
    groups = { 'superadmin', 'admin', 'god' },
    ace = 'qf_gardener.admin'
}

Config.TabletKey = 'F7'
Config.DesignKey = 'F6'
```

| Option                | Default                                               | Meaning                                                                                                                                                                                                                         |
| --------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Config.Locale`       | `'en'`                                                | Language on the first start. Afterwards it is changed in **Admin → General**.                                                                                                                                                   |
| `Config.Framework`    | `'auto'`                                              | `'esx'`, `'qbcore'`, `'qbox'` or `'auto'`.                                                                                                                                                                                      |
| `Config.Target`       | `'auto'`                                              | `'ox_target'`, `'qb-target'`, `'qtarget'`, `'none'` or `'auto'`. With `'none'` every spot has a ground ring, an arrow and a key prompt. With a target script only the arrow shows, and the spot is used through the target eye. |
| `Config.Notify`       | `'qf'`                                                | `'qf'` (built in), `'framework'`, `'ox_lib'` or `'custom'`.                                                                                                                                                                     |
| `Config.VehicleKeys`  | `'auto'`                                              | The keys resource for the work van. Also selectable in **Admin → Base and vehicles**.                                                                                                                                           |
| `Config.AdminCommand` | `'gardenadmin'`                                       | Command that opens the admin panel.                                                                                                                                                                                             |
| `Config.AdminAccess`  | `superadmin`, `admin`, `god`, ace `qf_gardener.admin` | Who is a full admin. Other groups get single modules in **Admin → Permissions**.                                                                                                                                                |
| `Config.TabletKey`    | `'F7'`                                                | Default key for the work tablet.                                                                                                                                                                                                |
| `Config.DesignKey`    | `'F6'`                                                | Default key for the design catalog.                                                                                                                                                                                             |

### Notifications (`Config.Notify`)

* `qf`: the built-in QF notifications. Help text shows as the script's own key prompt.
* `framework`: the notifications of ESX, QBCore or QBox.
* `ox_lib`: `lib.notify` and `lib.showTextUI`.
* `custom`: fill `NOTIFY.Custom` in `bridge/notify.client.lua`.

### Discord logs

Webhooks are set in `config/config.server.lua`. An empty URL turns that category off.

```lua
ConfigServer.Webhooks = {
    jobs = '',
    payouts = '',
    gardens = '',
    orders = '',
    admin = ''
}
```

| Category  | What is sent                                              |
| --------- | --------------------------------------------------------- |
| `jobs`    | Jobs taken and cancelled, with the crew.                  |
| `payouts` | Jobs finished: plot, rating, total and each member's pay. |
| `gardens` | Gardens saved on the map.                                 |
| `orders`  | Garden orders placed, completed and closed.               |
| `admin`   | Every change made in the admin panel.                     |

Logs go through a queue with a gap between messages, so Discord does not rate limit them. To send logs to your own logger, replace `Logs.Send` in `server/logs.lua`.

## Framework and Target

The bridges in `bridge/` hold the framework, target, notify and vehicle key integrations. With `'auto'` the script picks what is started, and a resource started later is still found.

| Module        | Side              | Functions                                                                                                                                                                            |
| ------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `FRAMEWORK`   | server            | `GetPlayer`, `GetIdentifier`, `GetPlayerName`, `GetJob`, `GetMoney`, `AddMoney`, `RemoveMoney`, `GetSourceByIdentifier`, `GetOfflineName`, `HasGroup`, `IsAdmin`, `RegisterCallback` |
| `FRAMEWORK`   | client            | `IsPlayerLoaded`, `GetPlayerData`, `TriggerCallback`, `IsDowned`, `IsMale`                                                                                                           |
| `TARGET`      | client            | `AddEntity`, `AddSphere`, `AddModel`, `Remove`                                                                                                                                       |
| `NOTIFY`      | client            | `Show`, `ShowHelp`, `HideHelp`                                                                                                                                                       |
| `VEHICLEKEYS` | server and client | `Give`, `Remove`                                                                                                                                                                     |

### Vehicle keys

Detected automatically: qb-vehiclekeys, qbx\_vehiclekeys, Renewed-Vehiclekeys, MrNewbVehicleKeys, wasabi\_carlock, qs-vehiclekeys, vehicles\_keys, mk\_vehiclekeys, t1ger\_keys, cd\_garage and okokGarage. The admin can pick one in **Admin → Base and vehicles**. For any other script fill `VEHICLEKEYS.CustomGive` and `VEHICLEKEYS.CustomRemove` in `bridge/vehiclekeys.server.lua` and `bridge/vehiclekeys.client.lua`.

### Payouts and Banking V2

When our [Banking \[V2\]](https://wiki.qfdevelopers.com/scripts/banking-v2.md) runs, payouts can go to the player's bank account and income tax is taken through its `PayIncomeTax` export. Bank or cash and the tax are set in **Admin → Economy**. Without Banking V2 the money goes through the framework.

## Your Own Look

The accent colour (default `#8cc63f`) is set in **Admin → General**. Each player picks the theme and the window size (75 to 110%) in the tablet settings. For full control over the interface edit `web/custom/custom.css`, which stays open after escrow.

## Editable Files

Everything that depends on your server is left open by escrow:

| File                                 | What it holds                                                                                                                        |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `config/config.lua`                  | The options above.                                                                                                                   |
| `config/config.server.lua`           | Discord webhooks.                                                                                                                    |
| `config/translations/<language>.lua` | Texts of every language.                                                                                                             |
| `bridge/*.lua`                       | Framework, target, notify and vehicle key integrations.                                                                              |
| `client/editable.lua`                | Help text, interaction key, restraint check, work clothes, animations and tool offsets, world props and effects, fuel, GPS, markers. |
| `server/editable.lua`                | Display names, who may work, payout and job hooks, owned properties.                                                                 |
| `server/logs.lua`                    | Discord logs.                                                                                                                        |
| `web/custom/custom.css`              | Your own styles for the interface.                                                                                                   |

Every open file starts with `-- @qf_editable <version>`. On start the resource prints the files that are older than the release, so after an update you know which ones to compare with the changelog. The hooks are described in [Additional Informations](https://wiki.qfdevelopers.com/scripts/gardener-v2/additional-informations.md#developer-api-hooks-and-exports).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://wiki.qfdevelopers.com/scripts/gardener-v2/configuration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
