> ## 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.

# Configuration

> Most of what makes an elevator — the floors, names, and job restrictions — is set in-game with /elevatoradmin. config.lua is just the global toggles.

Most of what makes an elevator — the floors, names, and job restrictions — is set in-game with `/elevatoradmin`. `config.lua` is just the global toggles.

## The settings you'll actually change

| Option                   | What it does                                                                                  | Default                  |
| ------------------------ | --------------------------------------------------------------------------------------------- | ------------------------ |
| `Config.Framework`       | `"qbox"`, `"qbcore"`, `"esx"`, or `"ox"`. Must match your server.                             | `"qbox"`                 |
| `Config.InteractKey`     | The key players press to open the elevator. `38` = E.                                         | `38`                     |
| `Config.ZoneSize`        | Size of the trigger zone at each floor. Make it bigger if players have trouble triggering it. | `vector3(2.0, 2.0, 4.0)` |
| `Config.FadeDuration`    | Screen fade time in ms during teleport.                                                       | `800`                    |
| `Config.FreezeOnTransit` | Freeze the player during the fade.                                                            | `true`                   |
| `Config.Debug`           | Draws the trigger zones so you can see them.                                                  | `false`                  |

## Sound effects

Each elevator phase has its own sound. Set any to `nil` to disable.

```lua theme={null}
Config.Sound = {
    enter  = { name = "Elevator_Open",          ref = "DLC_DMOD_Prop_Editor_Sounds" },
    move   = { name = "FLIGHT_DETAILS_TICKER",  ref = "DLC_HEIST_PLANNING_BOARD_SOUNDS" },
    arrive = { name = "Elevator_Close",         ref = "DLC_DMOD_Prop_Editor_Sounds" },
}
```

| Key      | When it plays        |
| -------- | -------------------- |
| `enter`  | The UI opens         |
| `move`   | The screen fades out |
| `arrive` | The player arrives   |

## Job restrictions

Set in the admin panel, not the config:

* **Elevator level** — only this job can use the whole elevator.
* **Floor level** — only this job (and grade) can pick this floor.

Players who don't meet the requirement see the elevator or floor locked.

## Default elevators

`Config.Elevators` at the bottom of `config.lua` is only read on the very first start — after that, all elevators are managed through `/elevatoradmin`. You can leave it alone after the first boot.
