> ## 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 Crafting on your FiveM server.

## Requirements

* FiveM server
* MySQL or MariaDB
* One of: [`qbx_core`](https://github.com/Qbox-project/qbx_core), [`qb-core`](https://github.com/qbcore-framework/qb-core), or [`es_extended`](https://github.com/esx-framework/esx_core)
* [`ox_lib`](https://github.com/overextended/ox_lib), [`ox_inventory`](https://github.com/overextended/ox_inventory), [`oxmysql`](https://github.com/overextended/oxmysql)
* [`object_gizmo`](https://github.com/DemiAutomatic/object_gizmo) (used by the in-game bench placer)

## Steps

1. Drop the `nex_crafting` folder into your resources, e.g. `resources/[nex]/nex_crafting/`.

2. Import `sql/install.sql` into your database. This creates the bench, recipe, ingredient, and XP tables.

3. *(Optional)* Open `settings/general.lua` and tweak commands, animations, XP, failure system, skill check, etc. You can also do this from the **Settings** tab of the creator panel later — it rewrites the file for you.

4. Add it to `server.cfg` **after** its dependencies:

   ```
   ensure ox_lib
   ensure oxmysql
   ensure ox_inventory
   ensure object_gizmo
   ensure nex_crafting
   ```

5. Grant access to the creator panel. Either:

   ```
   add_ace group.admin nex.crafting.creator allow
   ```

   …or rely on the default framework groups (`admin`, `superadmin`, `god`). Both are accepted out of the box — see [Configuration](/nex_crafting/configuration).

6. Restart your server.

That's it. Run `/craftpanel` (or `/crp`) in-game to add your first bench.

## Checking it worked

From F8:

```
lua print(GetResourceState('nex_crafting'))
```

Should print `started`. If it prints `missing` or `stopped`, fix `server.cfg` and restart.

## Updating

Your `settings/general.lua`, `settings/discord.lua`, and `integrations/*.lua` are listed under `escrow_ignore` and are preserved across updates. Bench and recipe data lives in MySQL and is preserved automatically.

1. Replace the resource files with the new version (keep your edited `settings/` and `integrations/` files).
2. Restart the server.

## Using a non-ox\_inventory inventory

The script ships wired to `ox_inventory`. If you use a different inventory, edit `integrations/inventory.lua` and point `settings.oxInventory.imagePath` in `settings/general.lua` at the right NUI image path.