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

# Installation

> A delivery job that runs from a tablet app: routes, crews, levels, training and porch theft.

Awoken Courier is a delivery job that lives on [Awoken Tablet](/resources/awoken-tablet/installation). Drivers pick a route in the app, load a van at the depot, and deliver to doorsteps across the map, alone or as a crew. Parcels left on a porch can be stolen by other players.

<CardGroup cols={2}>
  <Card title="Routes and crews" icon="route">
    Five tiers of route, unlocked by level. Bigger routes take a crew of drivers sharing one van.
  </Card>

  <Card title="Levels and training" icon="chart-line">
    XP for every delivery, training credits to spend on skills, and a reward at each promotion.
  </Card>

  <Card title="Leaderboard" icon="trophy">
    A weekly ranking that resets every Monday and pays out the top drivers.
  </Card>

  <Card title="Edited in game" icon="pen-ruler">
    Routes, pay, levels, loot, depots and every doorstep are changed from an admin panel, with no restart.
  </Card>
</CardGroup>

## Asset download

Once you buy from our official website, the asset lands in your [Cfx.re portal](https://portal.cfx.re/). Download it from there. The asset must sit on the keymaster account that made the purchase, or transfer it across first.

## What you need

<CardGroup cols={2}>
  <Card title="Required" icon="circle-check">
    **ox\_lib**, **oxmysql**, [**Awoken Bridge**](/resources/awoken-bridge/installation) and [**Awoken Tablet**](/resources/awoken-tablet/installation).
  </Card>

  <Card title="Detected, not required" icon="magnifying-glass">
    Your inventory, target, vehicle keys, fuel and dispatch resource. Awoken Bridge finds whatever is running.
  </Card>
</CardGroup>

Works on **QBox, QBCore and ESX**.

## Install

<Steps>
  <Step title="Install the bridge and the tablet first">
    Follow [Awoken Bridge](/resources/awoken-bridge/installation) and [Awoken Tablet](/resources/awoken-tablet/installation). The courier is an app on the tablet and cannot run without either.
  </Step>

  <Step title="Drop the folder in place">
    Put the **`awoken_courier`** folder into your server's `resources/`. Keep the folder name exactly `awoken_courier`.
  </Step>

  <Step title="Set the ensure order">
    ```cfg server.cfg theme={"dark"}
    ensure ox_lib
    ensure oxmysql
    ensure qbx_core            # your framework
    ensure ox_inventory        # and anything else the bridge should detect
    ensure awoken_bridge
    ensure awoken_tablet
    ensure awoken_courier
    ```
  </Step>

  <Step title="Give your admins the panel">
    Anyone in your normal admin groups can already open the admin panel and the creator. To grant it to someone else, or to keep it separate, add:

    ```cfg server.cfg theme={"dark"}
    add_ace group.admin awoken_courier.creator allow
    add_ace group.admin command.courier_admin allow
    ```

    The first is the admin panel and creator. The second is the [admin commands](/resources/awoken-courier/commands).
  </Step>

  <Step title="Start the server">
    The database tables create themselves. On the very first start the resource also imports a ready-made world: **eighteen areas and 484 doorsteps**, from South Central out to Paleto, along with the routes and loot tables.

    There is no SQL to run.
  </Step>

  <Step title="Run a shift">
    Go to the GoPostal depot marked on the map, talk to the clerk, and pick a route. If a van appears in a bay with a stack of parcels beside it, everything is working.
  </Step>
</Steps>

<Note>
  Want to draw your own world from scratch instead? Delete `install/world.sql` **before** the first start. An empty world is supported, and the import never runs a second time, so editing or deleting the shipped areas later is safe too.
</Note>

## The optional item

By default every player sees the courier app, so there is nothing to add to your inventory.

If you turn on `itemGate` in the [configuration](/resources/awoken-courier/configuration#who-sees-the-app), players need the `courier_usb` item. Open `install/inventories/` and paste the entry from the file named after your inventory.

| Inventory | Paste into |
| - | - |
| ox\_inventory | `ox_inventory/data/items.lua` |
| qb-inventory, ps-inventory, core\_inventory | `qb-core/shared/items.lua` |
| qs-inventory | `qs-inventory/shared/items.lua` |
| codem-inventory | `codem-inventory/shared/items.lua` |
| origen\_inventory | `origen_inventory/shared/items.lua` |
| tgiann-inventory | `tgiann-inventory/shared/items.lua` |

Then copy `install/images/courier_usb.png` into your inventory's image folder.

Parcels are not inventory items, so there is nothing to register for them.

## Updating

Re-download the asset from your Cfx.re portal, replace the folder, and restart.

Everything you changed in the admin panel lives in the database and survives an update: routes, pay, levels, loot, depots and doorsteps.

<Warning>
  Replacing the folder overwrites `config/`. Back it up first if you changed the app's name, colours or who can see it.
</Warning>

## Next steps

<CardGroup cols={2}>
  <Card title="Configuration" icon="sliders" href="/resources/awoken-courier/configuration">
    Branding, colours, the van and who sees the app.
  </Card>

  <Card title="In-game setup" icon="pen-ruler" href="/resources/awoken-courier/in-game-setup">
    The admin panel and the creator.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.