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

# atlasBridge Overview

> The shared foundation that connects Atlas resources to your framework, inventory, UI, target, and Discord.

`atlasBridge` is the shared foundation that every Atlas resource depends on. It exposes a single global `Bridge` table that normalizes your server stack — framework, inventory, UI, target, Discord — so Atlas scripts run the same on ESX, QBox, QB-Core, or standalone without you editing each resource.

Server owners install it once and start it before every other Atlas resource. For most servers there is nothing to configure: the bridge auto-detects your framework, inventory, and target system at startup.

<CardGroup cols={2}>
  <Card title="Install atlasBridge" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/rocket-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=f9ebbaa555e365b02e17af8d38a58a6d" href="/atlas-bridge/installation" width="24" height="24" data-path="icons/rocket-filled.svg">
    Place the resource, add the integration line to your scripts, and set the start order.
  </Card>

  <Card title="Configuration" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/wrench-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=2f07ced69c9d944e41df19ed19c921f6" href="/atlas-bridge/convars" width="24" height="24" data-path="icons/wrench-filled.svg">
    The full convar reference — framework, inventory, UI, target, theme, Discord.
  </Card>

  <Card title="Custom framework" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/plug-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=523bca8bdf53a69adf80f6699df734b4" href="/atlas-bridge/custom-framework" width="24" height="24" data-path="icons/plug-filled.svg">
    Run an unsupported framework? Fill the editable adapter against the contract.
  </Card>

  <Card title="Troubleshooting" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/life-ring-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=0b2743dc8feead8aae7162201f777f41" href="/atlas-bridge/troubleshooting" width="24" height="24" data-path="icons/life-ring-filled.svg">
    Fix startup, detection, UI, theme, and Discord issues.
  </Card>
</CardGroup>

## What atlasBridge handles

* **Framework** — normalized player, job, and money helpers (`Bridge.GetJob`, `Bridge.AddMoney`, …).
* **Inventory** — normalized item operations (`Bridge.Inventory.AddItem`, `HasItem`, …).
* **UI** — notifications, progress bars, menus, context menus, text UI, inputs, skill checks, confirmations, and a radial menu.
* **Target / interaction** — `ox_target`, `qb-target`, or the bridge's own world-anchored prompts.
* **Networking** — a protected client↔server layer with scrambled event names, token proofs, validation, and rate limiting.
* **Entities** — server-authoritative spawning and tracking, with automatic cleanup on disconnect.
* **Discord** — role and member helpers when a bot token is configured.
* **Permissions** — ACE- and Discord-role-aware permission nodes.
* **Theme** — a shared accent color for Atlas UI and marker props.

## Supported stacks

Everything below auto-detects. You only set a convar when you want to force a choice or run something unsupported (`custom`).

| Type          | Supported values                                                                     |
| ------------- | ------------------------------------------------------------------------------------ |
| **Framework** | `es_extended` · `qb-core` · `qbx_core` · standalone (`default`) · `custom`           |
| **Inventory** | `ox_inventory` · `qb-inventory` · `qs-inventory` · ESX legacy · `default` · `custom` |
| **UI**        | bridge-owned (`own`, default) · `ox_lib` (opt-in) · framework notify · `custom`      |
| **Target**    | `ox_target` · `qb-target` · bridge-owned (`own`) · `custom`                          |

<Note>
  The bridge's own NUI is the default — it has **zero dependencies**. `ox_lib` is opt-in: set `atlas:ui "ox"` (and start `ox_lib`) to use it. Anything a chosen provider does not implement falls back to the bridge's own NUI.
</Note>

## Where to go next

<CardGroup cols={2}>
  <Card title="Install it" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/rocket-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=f9ebbaa555e365b02e17af8d38a58a6d" href="/atlas-bridge/installation" width="24" height="24" data-path="icons/rocket-filled.svg">
    The single install page: placement, integration, and start order.
  </Card>

  <Card title="Configure providers" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/wrench-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=2f07ced69c9d944e41df19ed19c921f6" href="/atlas-bridge/convars" width="24" height="24" data-path="icons/wrench-filled.svg">
    Every convar with its values, default, and meaning.
  </Card>

  <Card title="Provider detection" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/plug-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=523bca8bdf53a69adf80f6699df734b4" href="/atlas-bridge/providers" width="24" height="24" data-path="icons/plug-filled.svg">
    How auto-detection resolves and when to force a provider.
  </Card>

  <Card title="Developer reference" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/list-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=63a56c709c49509bcc8a58f3893160bc" href="/atlas-bridge/developer/getting-started" width="24" height="24" data-path="icons/list-filled.svg">
    Build on the `Bridge` global — networking, data, UI, Discord.
  </Card>
</CardGroup>

<Warning>
  Keep the resource folder named exactly `atlasBridge`. Consumer scripts load it with `@atlasBridge/init.lua`; renaming the folder breaks that path and every dependent resource.
</Warning>