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

# Installation

### Requirements

* A framework: **qb-core**, **qbx\_core** or **es\_extended**
* **oxmysql**
* **SB Bridge**, which connects SB VIP to your inventory, notifications, text UI or target, vehicle keys, fuel and phone
* A **Tebex** webstore linked to your FiveM server
* *Optional:* **sbanticheat**, or any anticheat through `anticheat.lua`

### Steps

1. Put the `sbvip` folder in your resources folder.

> ⚠️ Keep the folder name exactly `sbvip`. The UI talks back to the resource by that name, so renaming it breaks the shop.

2. Start it in `server.cfg`, after your framework, inventory, oxmysql and SB Bridge:

```cfg
ensure oxmysql
ensure qb-core          # or qbx_core / es_extended
ensure ox_inventory     # your inventory
ensure sbtextui         # or whichever text UI / target SB Bridge uses
ensure sbbridge
ensure sbvip
```

3. Add your Tebex secret to `server.cfg`:

```cfg
set sv_tebexSecret "your-tebex-secret-key"
```

See [Tebex Setup](#) for where to find this key.

4. Tables are created automatically on first start. If you'd rather create them yourself, run `install.sql` first.
5. Set the main options in `config.lua`: `Config.Shop.Type`, `Config.Shop.Menu`, `Config.Vehicles.PurchaseSpawns`, `Config.TestDrive.Spawn`, `Config.Permissions`, `Config.Interaction` and `Config.Payment.MoneyAccount`.
6. *(Optional)* Paste your Discord webhook URLs into `server/webhooks.lua`.
7. Restart the server, join, and type `/vipadmin` to start adding products and Tebex packages.