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

## Requirements

* FiveM server
* One of: [`qbx_core`](https://github.com/Qbox-project/qbx_core), [`qb-core`](https://github.com/qbcore-framework/qb-core), [`es_extended`](https://github.com/esx-framework/esx_core), or [`ox_core`](https://github.com/overextended/ox_core)
* [`ox_lib`](https://github.com/overextended/ox_lib)

No database needed — elevator data is stored locally inside the resource.

## Steps

1. Drop the `nex_elevators` folder into `resources/[nex]/`.

2. Open `config.lua` and set `Config.Framework`:

   ```lua theme={null}
   -- "qbox", "qbcore", "esx", or "ox"
   Config.Framework = "qbox"
   ```

3. Add it to `server.cfg` **after** your framework and `ox_lib`:

   ```
   ensure ox_lib
   ensure nex_elevators
   ```

4. Restart your server. You should see something like `[nex_elevators] Imported 2 elevator(s) from config as defaults.` in the console.

That's it. Run `/elevatoradmin` in-game to start creating elevators.

## Updating

Your elevator data is in `data/elevators.json` inside the resource folder.

1. Back up `data/elevators.json`.
2. Replace the resource files with the new version.
3. Copy `data/elevators.json` back into the new `data/` folder.
4. Restart the server.

Your `config.lua` is preserved automatically.