Skip to main content
atlasBridge is designed to run with no configuration — it auto-detects your framework, inventory, and target system at startup. Every convar below is optional; set one only to force a choice or to enable an opt-in feature.
All convars use setr (replicated, readable client and server) except the Discord secrets, which use set so the token never reaches clients.

Quick reference

setr atlas:framework   "auto"     # auto | esx | qb | qbx | default | custom
setr atlas:inventory   "auto"     # auto | ox | qb | qs | esx | default | custom
setr atlas:ui          "own"      # own (default) | ox | framework | auto | custom
setr atlas:target      "auto"     # auto | ox | qb | own | custom
setr atlas:theme:color "#F487F4"  # any valid hex; live accent for UI + markers
setr atlas:debug       "false"    # true while testing only
# setr atlas:deathEvent "baseevents:onPlayerDied"   # only for custom death systems

# Discord (optional) — use `set`, NOT `setr`:
set atlas:discord:token "YOUR_BOT_TOKEN"
set atlas:discord:guild "YOUR_GUILD_ID"

Providers

Framework

atlas:framework
auto | esx | qb | qbx | default | custom
default:"auto"
Selects the framework provider. auto detects in the order qbx_core → es_extended → qb-core → default. Set custom to load editable/framework/{server,client}.lua. See the Providers guide for detection rules and the Custom Framework page for the adapter contract.
ValueResolves to
autoDetect automatically (default)
esxes_extended
qbqb-core
qbxqbx_core
defaultStandalone / no framework
customYour editable adapter

Inventory

atlas:inventory
auto | ox | qb | qs | esx | default | custom
default:"auto"
Selects the inventory provider. auto detects in the order ox_inventory → qb-inventory → qs-inventory → es_extended (legacy) → default. Set custom to load editable/inventory/{server,client}.lua. See Custom Inventory.
ValueResolves to
autoDetect automatically (default)
oxox_inventory
qbqb-inventory
qsqs-inventory
esxESX legacy inventory
defaultBridge virtual inventory
customYour editable adapter

Target / interaction

The target system has its own convar — atlas:target, not atlas:ui:target.
atlas:target
auto | ox | qb | own | custom
default:"auto"
Selects the target / interaction provider. auto detects in the order ox_target → qb-target → own (the bridge’s world-anchored prompts). Unlike framework/inventory, target resolves per call, so start order matters less.
ValueResolves to
autoDetect automatically (default)
oxox_target
qbqb-target
ownBridge-owned interaction prompts
customYour editable adapter

UI

atlas:ui
own | ox | framework | auto | custom
default:"own"
The global UI mode. The default is the bridge’s own zero-dependency NUI — ox_lib is opt-in, not automatic. ox swaps every supported call site to ox_lib (which must be started); framework uses the framework’s native notify (notifications only); auto resolves to own (kept for compatibility — it detects ox_lib started → ox, a non-default framework → framework, otherwise own). Anything a chosen provider does not implement falls back to the bridge’s own NUI automatically.
ValueRenderer
ownThe bridge’s own NUI — zero dependencies (default)
oxox_lib (must be started)
frameworkThe framework’s native notify (notifications only)
autoResolves to own
customYour editable adapter (editable/ui.lua)
You can override any individual UI subsystem. A per-subsystem convar wins over the global atlas:ui; leaving it blank inherits atlas:ui. The full subsystem list is exactly:
setr atlas:ui:notify     "own"
setr atlas:ui:progress   "ox"
setr atlas:ui:menu       "own"
setr atlas:ui:textui     "own"
setr atlas:ui:context    "own"
setr atlas:ui:input      "own"
setr atlas:ui:skillcheck "own"
setr atlas:ui:confirm    "own"
Subsystem convarControls
atlas:ui:notifyNotifications
atlas:ui:progressProgress bars
atlas:ui:menuList / side menus
atlas:ui:textuiPersistent text hint UI
atlas:ui:contextContext menus
atlas:ui:inputInput dialogs
atlas:ui:skillcheckSkill checks
atlas:ui:confirmConfirmation dialogs
The radial menu is always the bridge’s own NUI and is not configurable.

Theme color

atlas:theme:color
hex color
default:"#F487F4"
The accent color used across bridge UI and marker props. Accepts any valid hex string. The color is live — it follows marker-prop recolor at runtime. The true default is #F487F4.
setr atlas:theme:color "#F487F4"

Death detection

atlasBridge detects most player deaths automatically (via CEventNetworkEntityDamage and a health watcher). Only set this convar if your server uses a custom death/ambulance system and an Atlas resource fails to react when a player dies.
atlas:deathEvent
event name
An extra death event to route through the bridge. Use the event name from your death/ambulance system. Leave it unset on a standard server.
setr atlas:deathEvent "baseevents:onPlayerDied"

Debug

atlas:debug
true | false
default:"false"
Enables verbose detection and networking logs. Turn it on while diagnosing provider detection or net issues, then turn it off for production.
setr atlas:debug "true"

Discord

Discord is optional and disabled unless both values are set. Store these with set, never setr.
atlas:discord:token
bot token (set)
Your Discord bot token. The bridge talks to the Discord REST API directly with no separate bot process. The token is only ever used in an Authorization header server-side.
atlas:discord:guild
guild id (set)
Your Discord server (guild) ID. Required for role and member lookups.
set atlas:discord:token "YOUR_BOT_TOKEN"
set atlas:discord:guild "YOUR_GUILD_ID"
Never use setr for the bot token. setr replicates values to clients, which would leak the token. Use set for server-only secrets. See Permissions for the API.