> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thecruxstudio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Install Crux Studio Scripts on Your FiveM Server

> Complete installation guide for Crux Studio FiveM scripts: dependencies, configuration, job grades, inventory items, and resource startup.

Every Crux Studio script follows the same installation pattern. Once you've been through it once, you'll find each new script drops in quickly. The steps below apply to all products — Restaurant Scripts V1, Restaurant Scripts V2, and the Advanced Series alike. Individual script pages list the specific item definitions, job grades, and resource names for that script.

<Steps>
  <Step title="Install Dependencies">
    Before you place the script in your server, make sure these three resources are present and up to date:

    | Dependency | Minimum Version | Where to Get It                                                                 |
    | ---------- | --------------- | ------------------------------------------------------------------------------- |
    | `ox_lib`   | v3.30.6         | [GitHub Releases](https://github.com/overextended/ox_lib/releases/tag/v3.30.6)  |
    | `oxmysql`  | v2.12.0         | [GitHub Releases](https://github.com/overextended/oxmysql/releases/tag/v2.12.0) |
    | `crux_lib` | Bundled         | Included inside the script's download folder — no separate download needed      |

    Place `ox_lib` and `oxmysql` in your server's `resources` folder if they aren't there already. `crux_lib` is already in the script ZIP you received — just move it alongside the main script resource.
  </Step>

  <Step title="Configure the Script">
    Open the script's folder and navigate to `config/config.lua`. Read through every option and adjust the values to match your server's setup — job names, prices, coordinates, and feature toggles all live here.

    <Tip>
      The script's `README` file (included in the download) describes each config key in detail. Read it before editing to avoid misconfiguration.
    </Tip>
  </Step>

  <Step title="Add Job Grades">
    Each restaurant and job script includes a pre-built job grade definition. Add it to your framework using the method below for your setup:

    <Tabs>
      <Tab title="QBCore">
        Copy the job grade block from the script's `README` and paste it into:

        ```
        qb-core/shared/jobs.lua
        ```
      </Tab>

      <Tab title="QBox">
        Copy the job grade block from the script's `README` and paste it into:

        ```
        qbx_core/shared/jobs.lua
        ```
      </Tab>

      <Tab title="ESX">
        Run the SQL statements provided in the script's `install_ESX.md` file against your database. This inserts the job and grade rows directly into your ESX tables.
      </Tab>
    </Tabs>
  </Step>

  <Step title="Add Inventory Items">
    Open the `install` folder inside the script. You'll find item definitions and item images organised for each supported inventory system.

    <Tabs>
      <Tab title="qb-inventory">
        1. Copy the item definitions from the script's `README` into:
           ```
           qb-core/shared/items.lua
           ```
        2. Copy all images from `/install/images` into:
           ```
           qb-inventory/html/images
           ```
      </Tab>

      <Tab title="ox_inventory">
        1. Copy the item definitions from the script's `README` into:
           ```
           ox_inventory/data/items.lua
           ```
        2. Copy all images from `/install/images` into:
           ```
           ox_inventory/web/images
           ```
      </Tab>

      <Tab title="qs-inventory">
        1. Copy the item definitions from the script's `README` into your `qs-inventory` items file.
        2. Copy all images from `/install/images` into:
           ```
           qs-inventory/html/images
           ```
      </Tab>

      <Tab title="tgiann-inventory">
        1. Copy the item definitions from the script's `README` into:
           ```
           qb-core/shared/items.lua
           ```
        2. Copy all images from `/install/images` into:
           ```
           qb-inventory/html/images
           ```
      </Tab>
    </Tabs>

    <Note>
      The exact item definitions for each script (item names, labels, weights, and images) are listed on that script's individual documentation page, not here.
    </Note>
  </Step>

  <Step title="Ensure Resources">
    Add the resources to your server's `server.cfg` in this order. Always ensure `ox_lib` and `crux_lib` **before** the script itself:

    ```
    ensure ox_lib
    ensure crux_lib
    ensure crux-[scriptname]
    ```

    Replace `crux-[scriptname]` with the actual resource folder name for the script you're installing. You'll find the exact name on the script's individual documentation page.

    <Warning>
      If `crux_lib` starts after the script resource, the script will throw errors on startup. Order matters.
    </Warning>
  </Step>
</Steps>

***

## Livery Installation

Some Crux Studio scripts include custom vehicle liveries for delivery vehicles (such as the Vapid Speedo Express). If your script has a livery component, follow these additional steps after the main installation.

### Step 1 — Install the Base Vehicle from GTA5-Mods.com

Download and install the **Vapid Speedo Express \[Add-On | Liveries | Legacy | Enhanced]** mod from GTA5-Mods.com:

[https://www.gta5-mods.com/vehicles/vapid-speedo-express-add-on-liveries](https://www.gta5-mods.com/vehicles/vapid-speedo-express-add-on-liveries)

Follow the mod's own installation instructions to add the vehicle to your server as a streamed add-on.

### Step 2 — Replace the YTD Livery File

Once the base vehicle is installed, locate the custom livery YTD file included in your script's download. Replace the default YTD file in the vehicle's stream folder with the Crux Studio-branded version to apply the correct livery texture.