# Requirements & Installation

## Requirements

| Requirement | Status |
|---|---|
| FiveM server | Required |
| OneSync | Required for authoritative entity checks |
| `oxmysql` | Required when persistence/ownership tables are used |
| QBCore / QBX / ESX | Optional |
| `nord_inventory` | Recommended for native physical-key metadata |
| `ox_inventory` | Supported for generic item checks |
| `ox_lib` | Optional notification/Text UI provider |

## Resource installation

1. Copy the folder as `nord_vehiclekeys` into your resources directory.
2. Start the database resource first.
3. Start your framework and inventory before Nord Vehicle Keys.
4. Add the recovery admin ACE if staff will manage recovery NPCs.
5. Ensure the resource.

```cfg
ensure oxmysql
ensure qb-core          # or qbx_core / es_extended when used
ensure nord_inventory   # recommended for physical vehicle_key items
ensure nord_vehiclekeys
```

Recovery admin permission:

```cfg
add_ace group.admin nord.vehiclekeys.admin allow
```

## Database

Auto SQL is enabled by default. The resource creates and validates its own tables at startup.

For a manual install, import:

```text
sql/install.sql
```