> For the complete documentation index, see [llms.txt](https://bros-development.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bros-development.gitbook.io/documentation/scripts/openapi/installation.md).

# 📦 Installation

🔧 Installation Guide

Developed by Bros Development

BrosDev Elevator Creator is designed to be simple to install while still giving full flexibility for advanced server setups. Follow the steps below carefully to ensure everything works correctly.

***

🚀 Step 1 — Download & Extract\
Download the resource from your official Tebex purchase and extract it into your server resources folder.

Place it inside a clean directory structure like:

```
resources/[brosdev]/BrosDev_ElevatorCreator  
```

You can rename the folder if needed, but it is recommended to keep the default name for consistency and support purposes.

***

⚙️ Step 2 — Server.cfg Setup\
Add the resource to your `server.cfg` in the correct order:

```cfg
ensure oxmysql  
ensure BrosDev_ElevatorCreator  
```

If you are using ox\_lib, make sure it is started before or alongside the script:

```cfg
ensure ox_lib  
```

***

🗄️ Step 3 — Database Setup\
The script uses **oxmysql** and automatically creates the required table on first start if enabled.

If you prefer manual setup, run this SQL:

```sql
CREATE TABLE IF NOT EXISTS `elevators` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `elevator_id` VARCHAR(64) NOT NULL UNIQUE,
    `name` VARCHAR(128) NOT NULL DEFAULT 'Elevator',
    `creator` VARCHAR(128) DEFAULT NULL,
    `creator_name` VARCHAR(128) DEFAULT NULL,
    `floors` LONGTEXT NOT NULL,
    `settings` LONGTEXT NOT NULL,
    `permissions` LONGTEXT DEFAULT NULL,
    `linked_elevators` LONGTEXT DEFAULT NULL,
    `stats` LONGTEXT DEFAULT NULL,
    `active` TINYINT(1) NOT NULL DEFAULT 1,
    `created_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    `updated_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);
```

***

🔐 Step 4 — Admin Access Setup\
To access the elevator creator menu, you must grant yourself admin permissions.

#### Option 1 — ACE Permission (Recommended)

```cfg
add_ace identifier.license:YOUR_LICENSE_HERE elevator.creator allow  
```

#### Option 2 — Config Identifiers

Add your identifier inside `config.lua`:

```lua
Config.AdminIdentifiers = {
    'license:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
}
```

#### Option 3 — Admin Groups

If you are using framework groups:

```lua
Config.AdminGroups = { 'admin', 'god', 'superadmin', 'owner', 'developer' }
```

***

🎮 Step 5 — Start the Resource\
Restart your server or manually start the script:

```
restart BrosDev_ElevatorCreator  
```

If everything is correct, the system will load automatically without errors.

***

🧪 Step 6 — First Test\
Once in-game, use:

```
/elevatorcreator
```

This will open the in-game elevator creation UI. From here you can:

* Create your first elevator
* Add floors
* Set positions
* Configure permissions
* Save and test instantly

***

⚠️ Important Notes

* Always ensure **oxmysql** is started before the script
* Do not modify core files unless required
* Use `Config.Debug = true` only for troubleshooting
* Make sure framework and target systems are correctly set to `auto`
* Restart resource after major config changes

***

💡 Once installed correctly, you will have full in-game control over all elevator systems without ever touching config files again.