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

# Installation

## Requirements

* A working FiveM server with OneSync enabled. The manifest declares `/onesync` as a dependency.
* The truck and trailer resources enabled in your fleet configuration.
* Your selected framework and its dependencies, if using ESX, QBCore, or Qbox.

Standalone Hot-Shot does not require a SQL database, inventory resource, Discord integration, or framework. It records earnings internally; depositing game currency requires a framework adapter or a custom server integration.

Truck and trailer models are **not included** in this script. The stock GTA forklift is used for crate loading.

## Install the resource

{% stepper %}
{% step %}

### Back up your existing installation

Back up an existing installation and its server KVP data.
{% endstep %}

{% step %}

### Copy the runtime folder

Copy the complete runtime folder into your server's resources directory. Keep `fxmanifest.lua` directly inside the resource folder.
{% endstep %}

{% step %}

### Name the new deployment

For a new deployment, this guide uses the resource name `hotshot_trucking`. The source project is named `hotshot_trucking_simulator`; these are different folder contexts.
{% endstep %}

{% step %}

### Keep existing resource names stable

Keep an existing deployment's resource name stable so its KVP namespace and integrations continue to match.
{% endstep %}

{% step %}

### Configure and start dependencies

Edit the installed copy's five `config/` files and start dependencies first.
{% endstep %}
{% endstepper %}

Example new-install layout:

```
resources/
  [jobs]/
    hotshot_trucking/
      fxmanifest.lua
      config/
      shared/
      client/
      server/
      stream/
      web/
```

Use the complete 1.33.2 beta release folder. Keep all manifest-listed runtime files and streamed cargo assets together, including `client/tutorial.lua`, `web/tutorial.js`, and the updated web styles. Do not run a development copy and a deployment copy simultaneously.

## Vehicle setup

The release enables one company work truck at level 1 and 20-, 30-, and 40-foot flatbed trailers at levels 1, 3, and 6. Install the truck and trailer resources enabled in `config/vehicles.lua`. Use the actual resource-folder and model spawn names from your installed vehicle packages. Match the company-truck catalog, trailer catalog, approved tow vehicles, and compatibility table to that equipment.

Cargo layouts must fit the selected trailer models. Check `config/cargo.lua` before enabling a new model; a similar appearance or deck length does not guarantee compatible attachment points or collision.

Start any dependencies required by your vehicle packages before the vehicles themselves. Consult the packages' installation instructions for those requirements.

## Start order

For a standalone installation, start your vehicle packages and their dependencies first, then Hot-Shot:

```cfg
# Add ensure entries for your installed truck/trailer resources above this line.
ensure hotshot_trucking
```

The vehicle entries are server-specific; copy the exact folder names from your installation. If DiscordAcePerms supplies your role permissions, start it and its dependencies before Hot-Shot and verify that the player receives the required ACE grants.

On a framework server, start `es_extended`, `qb-core`, or `qbx_core` and its dependencies before Hot-Shot. Start `qbx_vehiclekeys` before Hot-Shot if using that optional adapter.

Use your actual resource folder names. After adding a new resource, run these in the server console:

```
refresh
ensure hotshot_trucking
```

For an already running installation, finish active work and return equipment before restarting it during maintenance.

## First startup check

{% stepper %}
{% step %}

### Check the server console

Check the server console for configuration and missing-resource errors.
{% endstep %}

{% step %}

### Join the server

Join with a fully loaded player/character.
{% endstep %}

{% step %}

### Visit Hot-Shot Yard

Visit Hot-Shot Yard at `1002.0067, -2366.0708, 30.5111`.
{% endstep %}

{% step %}

### Check out equipment

Check out the company work truck and compatible 20-foot trailer. Wait for Ready, then hitch manually.
{% endstep %}

{% step %}

### Complete a delivery

Accept level-1 Building Materials and complete the [first delivery](/baobab-interactive-docs/hotshot-trucking-simulator/first-delivery.md).
{% endstep %}

{% step %}

### Verify retained progress

Reconnect and verify your progress is retained.
{% endstep %}
{% endstepper %}

Set intended access rules before inviting players. The release uses `discordace` for both trucking and DOT, with separate `hotshot.trucking` and `hotshot.dot` permissions. Grant those permissions through your server's ACE principals or DiscordAcePerms mappings, or deliberately choose another supported policy. See [Frameworks and access](/baobab-interactive-docs/hotshot-trucking-simulator/frameworks-and-access.md).