> ## 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

> The one resource every other Awoken script asks which framework, inventory and dispatch you run.

Awoken Bridge owns no gameplay. It answers one question, "who does X on this server", so that every other Awoken resource can stop carrying its own copy of the answer.

You install it once. Every Awoken script that talks to another resource depends on it.

## 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**, and nothing else.
  </Card>

  <Card title="Detected, not required" icon="magnifying-glass">
    Your framework, inventory, target, dispatch, phone, keys, fuel and logging resource. Whatever is running gets picked up.
  </Card>
</CardGroup>

Works on **QBox, QBCore, and ESX**, and **standalone** with no framework at all.

## Install

<Steps>
  <Step title="Drop the folder in place">
    Put the **`awoken_bridge`** folder into your server's `resources/`. Keep the folder name exactly `awoken_bridge`: it is the name every other resource calls its exports by.
  </Step>

  <Step title="Set the ensure order">
    ```cfg server.cfg theme={"dark"}
    ensure ox_lib
    ensure qbx_core            # your framework: qbx_core / qb-core / es_extended
    ensure ox_inventory        # and anything else it should detect
    ensure awoken_bridge	   # then every Awoken script, after the bridge
    ```

    <Warning>
      Order matters more here than anywhere else. Detection is a resource state check at load time, so anything that starts **after** the bridge is invisible to it. Everything it should find goes above it, and every Awoken script goes below it.
    </Warning>
  </Step>

  <Step title="Start the server and read one line">
    The bridge prints what it picked for each job at boot. That line is the first thing to look at whenever an Awoken script says nothing happened.

    ```
    [awoken_bridge] framework: qbx | inventory: ox_inventory | dispatch: ps-dispatch | ...
    ```
  </Step>
</Steps>

## Updating

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

<Warning>
  Replacing the folder overwrites `config/`. Back it up first if you have named anything explicitly in there.
</Warning>

## First check

Anything reported as `none` is usually correct, meaning you do not run one. Occasionally it is the whole bug, so it is worth a glance before raising a ticket.

<CardGroup cols={2}>
  <Card title="Configuration" icon="sliders" href="/resources/awoken-bridge/configuration">
    Naming a backend when detection guesses wrong.
  </Card>

  <Card title="Exports" icon="code" href="/resources/awoken-bridge/exports">
    The surface every Awoken script is written against.
  </Card>
</CardGroup>