> For the complete documentation index, see [llms.txt](https://docs.kojascripts.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kojascripts.eu/jobs/trucker/installation.md).

# Installation

{% stepper %}
{% step %}

## Dependencies

Make sure these are installed and started **before** Koja Trucker:

```cfg
ensure oxmysql
ensure koja-lib
```

{% endstep %}

{% step %}

## Drop in the resource

1. Extract the resource into your server's `resources` directory.
2. Keep the folder name **`koja-trucker`** (exports and events are namespaced to it).
3. Add it to your `server.cfg`:

```cfg
ensure koja-trucker
```

{% endstep %}

{% step %}

## Database

The required tables are created **automatically** on first start (controlled by `general.autoCreateTable` in the config). You don't need to import any SQL.

The resource owns these tables — all prefixed `koja-trucker*`:

| Table                                | Purpose                                            |
| ------------------------------------ | -------------------------------------------------- |
| `koja-trucker`                       | Per-player level, XP, skill points, skills, totals |
| `koja-trucker-accounts`              | Display name & account type                        |
| `koja-trucker-companies`             | Companies                                          |
| `koja-trucker-company-members`       | Membership & roles                                 |
| `koja-trucker-company-invitations`   | Outgoing invites                                   |
| `koja-trucker-company-requests`      | Join requests                                      |
| `koja-trucker-company-activity`      | Live activity feed                                 |
| `koja-trucker-shipment-history`      | Delivery history                                   |
| `koja-trucker-promocodes`            | Promo codes                                        |
| `koja-trucker-promocode-redemptions` | Who redeemed what                                  |
| `koja-trucker-quests`                | Per-player daily/weekly quest state                |

{% hint style="warning" %}
If you manage migrations yourself, set `autoCreateTable` to `false` in the config (or toggle **Auto-create database table** off in the admin panel).
{% endhint %}
{% endstep %}

{% step %}

## Framework

Koja Trucker auto-detects **ESX**, **QBCore** or **ox** through `koja-lib`. No manual bridge configuration is required in the common case.
{% endstep %}

{% step %}

## First launch

1. Start the server and join.
2. Open the tablet (default command **`/trucker`** — see [Configuration](broken://pages/391912b0afd5cdacdb4d514607b8fdee7d8413ee) to rename it).
3. Grant yourself admin (see [Admin panel](broken://pages/ade42fd89dc68a7c95be90d57bc328f13f4f4e6d)) to start creating depots and orders.
   {% endstep %}
   {% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.kojascripts.eu/jobs/trucker/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
