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

# Installation

> Install atlasBridge, wire it into your resources, and set the correct start order.

Install `atlasBridge` once, before any Atlas resource. Every dependent script reaches it through a single `shared_script` line.

## Requirements

* Keep the folder named exactly `atlasBridge`.
* Start `atlasBridge` **before** any resource that depends on it.
* Keep the included `web/dist` build folder inside the resource.

## 1. Place the resource

Drop `atlasBridge` into your resources folder. The recommended layout keeps Atlas resources together:

```text theme={null}
resources/
  [ATLAS]/
    atlasBridge/
    atlasFishing/
```

<Warning>
  The folder must be named exactly `atlasBridge`. Consumers load it with `@atlasBridge/init.lua`, so a renamed folder breaks every dependent resource.
</Warning>

## 2. Integrate it into your resources

In each consumer resource's `fxmanifest.lua`, declare the dependency and pull in the `Bridge` global:

```lua theme={null}
dependency 'atlasBridge'                 -- enforces load order
shared_script '@atlasBridge/init.lua'    -- gives you the global `Bridge` (client + server)
```

That single `shared_script` line assembles the `Bridge` table inside your resource's Lua VM. Pure-Lua utilities run in your VM; stateful services (UI, networking, entities) route to atlasBridge automatically — you never call its exports yourself.

<Note>
  Atlas resources you purchase already include these lines. You only add them manually when building your own scripts on top of the bridge — see the [Developer Reference](/atlas-bridge/developer/getting-started).
</Note>

## 3. Set the start order

`atlasBridge` must start **after** your framework and inventory (so auto-detection can see them) and **before** any Atlas resource that depends on it.

```cfg theme={null}
# dependencies first
ensure oxmysql
ensure ox_lib
ensure ox_inventory
ensure qbx_core

# then the bridge
ensure atlasBridge

# then Atlas resources
ensure atlasFishing
```

<Warning>
  Framework and inventory are detected **once at boot**. A framework that starts after `atlasBridge` will not be picked up until the bridge restarts. UI and target resolve per call, so they are more flexible.
</Warning>

## 4. Verify the UI build

Confirm the committed NUI build is present:

```text theme={null}
atlasBridge/web/dist/index.html
```

Bridge-owned UI (notifications, progress, menus, the radial menu, and interaction prompts) relies on this build. A fresh copy of the resource ships with it already built — you only need to rebuild if you change `web/src/`.

## 5. First startup test

<Steps>
  <Step title="Start dependencies">
    Start your framework, inventory, and optionally `ox_lib` / a target resource first.
  </Step>

  <Step title="Start atlasBridge">
    `ensure atlasBridge` after dependencies. Watch the console for the adapter lines (for example `[Framework] server adapter: es_extended`).
  </Step>

  <Step title="Start an Atlas resource">
    `ensure atlasFishing` (or another Atlas resource) after the bridge.
  </Step>

  <Step title="Check for warnings">
    Fix any missing-NUI, wrong-detection, or resource-name warnings before continuing.
  </Step>
</Steps>

## Next steps

<CardGroup cols={2}>
  <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">
    Force a provider, set the theme color, or configure Discord.
  </Card>

  <Card title="Install your resource" icon="https://mintcdn.com/atlasscripts/BwePy2Q7bMLnl0yQ/icons/fish-filled.svg?fit=max&auto=format&n=BwePy2Q7bMLnl0yQ&q=85&s=9fb379f2676a179b557d1696af269d2f" href="/atlas-fishing/installation" width="24" height="24" data-path="icons/fish-filled.svg">
    Once the bridge starts cleanly, install the Atlas resource you purchased.
  </Card>
</CardGroup>