> For the complete documentation index, see [llms.txt](https://atiysus-organization.gitbook.io/aty-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://atiysus-organization.gitbook.io/aty-scripts/zone-creator/getting-started/installation.md).

# Installation

### 1. Requirements

* A FiveM server on a recent artifact build.
* **aty\_lib** installed and started **before** this resource (the framework/inventory/target bridge).
* One of **QBCore**, **ESX** or **Qbox** (auto-detected through `aty_lib`).

### 2. Install

1. Drop the `aty_zonecreator` folder into your `resources` directory (inside a category folder is fine, e.g. `[aty]/aty_zonecreator`).
2. Make sure `aty_lib` starts first, then add the resource to your `server.cfg`:

```cfg
ensure aty_lib
ensure aty_zonecreator
```

3. (Optional) For zone **ambient sounds**, also install and start `aty_3dsound` and fill in the URLs in `config.lua`. Without it, zones still work — the sound step is simply skipped.

### 3. Grant admin access

The panel is admin-only. Pick **one** of the methods below (details in Permissions & Roles):

```cfg
# ACE (works on any framework)
add_ace group.admin command.zonecreator allow
```

or rely on your framework's admin permission (QBCore `admin`/`god`, ESX `admin`/`superadmin`) — both are configured out of the box.

### 4. Open it

In-game, run:

```
/zonemanager
```

The management panel opens. Draw your first zone from **Add Zone** (top-right).

{% hint style="success" %}
Everything you configure is saved automatically — there is no Save button. See Drawing Zones.
{% endhint %}

### 5. Storage

By default zones are stored in a local **`zones.json`** file inside the resource. To use a database instead, set `Config.Storage = 'oxmysql'` — the `aty_zones` table is created automatically on first start. See the config reference.

### Updating

Replace the resource folder with the new version and restart it. Your `config.lua` is listed in `escrow_ignore`, and `zones.json` / the `aty_zones` table are untouched by updates — your zones and settings are preserved.