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

# Installation

Follow the steps below to install **Crimvex Rental** on your FiveM QBCore server.

### 1️⃣ Import the SQL File

Navigate to the `sql` folder included with the resource and import the provided SQL file into your server's database.

This will automatically create all the required database tables used by the rental system.

### 2️⃣ Install the Resource

```
resources/
└── [crimvex]/
    └── crimvex-rental
```

### 3️⃣ Install Dependencies

Make sure the following resources are installed and running on your server:

* [ox\_lib](https://github.com/overextended/ox_lib)
* [ox\_target](https://github.com/overextended/ox_target)
* [oxmysql](https://github.com/overextended/oxmysql)

> **Note:** The script will not function correctly if any required dependency is missing.

### 4️⃣ Ensure the Resource

Add the following line to your `server.cfg` after all dependencies have started.

```cfg
ensure crimvex-rental
```

***

### 5️⃣ Configure the Script

Open the configuration files inside the resource and customize:

* Rental locations
* Vehicles
* Rental prices
* Rental duration
* Refund settings
* VIP vehicles
* Discord role IDs (optional)

Configure everything according to your server's needs before starting the resource.

***

### 6️⃣ Restart Your Server

Restart your FiveM server or execute:

```cfg
refresh
ensure crimvex-rental
```

***

### ✅ Installation Complete

If everything has been installed correctly, rental locations will appear in-game and players will be able to rent vehicles immediately.

If you encounter any issues, please refer to the **Troubleshooting** section or join our Discord server for support.