> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nexdev.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> How to install NEX Donator System on your FiveM server.

## Requirements

| Dependency                                                                                                                                                                                                    | Notes                                                                                                                        |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| **Qbox** ([`qbx_core`](https://github.com/Qbox-project/qbx_core)) **or** [`qb-core`](https://github.com/qbcore-framework/qb-core) **or** **ESX** ([`es_extended`](https://github.com/esx-framework/esx_core)) | Auto-detected. Any of the three works out of the box.                                                                        |
| [`ox_lib`](https://github.com/overextended/ox_lib)                                                                                                                                                            | Notifications and callbacks.                                                                                                 |
| [`oxmysql`](https://github.com/overextended/oxmysql)                                                                                                                                                          | Database driver.                                                                                                             |
| [`ox_inventory`](https://github.com/overextended/ox_inventory)                                                                                                                                                | Recommended for item / weapon delivery on every framework. Script falls back to the framework's native inventory if missing. |
| Any vehicle-keys script *(optional)*                                                                                                                                                                          | Auto-detected — see [Configuration](/nex_donatorsystem/configuration#vehicle-keys).                                          |

You also need a [Tebex](https://www.tebex.io/) store with at least one currency package set up.

## Steps

1. Drop the `nex_donatorsystem` folder into your `resources/` tree, e.g.:

   ```
   resources/[assets]/nex_donatorsystem
   ```

2. Add it to your `server.cfg` after your framework and `ox_inventory`:

   ```
   ensure nex_donatorsystem
   ```

3. Start the server. The database tables create themselves on first boot. You should see:

   ```
   [nex_donatorsystem][schema] 7/7 tables verified, 4 default categories seeded.
   [nex_donatorsystem] Loaded 0 items, 4 categories, 0 deals.
   ```

That's the resource installed. Next, wire up your Tebex store — see [Tebex setup](/nex_donatorsystem/tebex-setup).

<Info>
  The schema is idempotent. Every restart re-verifies the tables and seeds default categories if any are missing, so you can never end up half-installed. There's no `.sql` file to import.
</Info>

## Checking it worked

From your server console:

```
state nex_donatorsystem
```

Should print `started`. From F8 in-game:

```
lua print(GetResourceState('nex_donatorsystem'))
```

Same result.

## Updating

`configs/config.lua` and `configs/sv_config.lua` are the only files you edit. Both are `escrow_ignore`d on protected builds, so your settings survive updates.

1. Replace the resource files with the new version (keep your edited `configs/config.lua` and `configs/sv_config.lua`).
2. Restart the resource:

   ```
   restart nex_donatorsystem
   ```