Skip to main content
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:
The folder must be named exactly atlasBridge. Consumers load it with @atlasBridge/init.lua, so a renamed folder breaks every dependent resource.

​
2. Integrate it into your resources

In each consumer resource’s fxmanifest.lua, declare the dependency and pull in the Bridge global:
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.
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.

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

​
4. Verify the UI build

Confirm the committed NUI build is present:
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

1

Start dependencies

Start your framework, inventory, and optionally ox_lib / a target resource first.
2

Start atlasBridge

ensure atlasBridge after dependencies. Watch the console for the adapter lines (for example [Framework] server adapter: es_extended).
3

Start an Atlas resource

ensure atlasFishing (or another Atlas resource) after the bridge.
4

Check for warnings

Fix any missing-NUI, wrong-detection, or resource-name warnings before continuing.

​
Next steps

Configuration

Force a provider, set the theme color, or configure Discord.

Install your resource

Once the bridge starts cleanly, install the Atlas resource you purchased.