Dependencies
Required and selected dependencies, start order, and provider requirements for Orbit Lib.
Dependencies
Orbit Lib always requires its two manifest libraries. Framework, inventory, target, and interface dependencies then depend on the exact selectors in config.lua.
Required
| Dependency | Why it is needed | Link |
|---|---|---|
ox_lib | Loads the shared library, callbacks, cache helpers, and common runtime utilities used by the bridges. | overextended/ox_lib |
oxmysql | Satisfies the manifest dependency and database library loaded by the server runtime. | overextended/oxmysql |
Selected integrations
| Selector | Required running resource |
|---|---|
Config.Framework = 'esx' | es_extended |
Config.Framework = 'qb' | qb-core |
Config.Framework = 'qbx' | qbx_core |
Config.Framework = 'standalone' | No framework resource; configure standalone adapters instead. |
Config.TargetResource = 'ox_target' | ox_target |
Config.TargetResource = 'qb-target' | qb-target |
Built-in Config.Inventory value | The matching inventory resource. |
Config.Inventory = 'qb-like' or 'ox-like' | The resource named by Config.CustomInventory. |
See Configuration for the complete supported inventory list and custom export rules.
Interface providers
| Provider | Additional requirement |
|---|---|
framework notifications | ESX or QB-Core. QBX and standalone fall back to ox_lib. |
framework progress | QB-Core also requires progressbar; ESX also requires esx_progressbar. QBX and standalone fall back to ox_lib. |
ox_lib | Already installed as a required dependency. |
orbit-dynamichud-v2 | Orbit Dynamic HUD 2.0, started after Orbit Lib. |
Text UI and skill checks support only ox_lib or orbit-dynamichud; they do not accept framework.
Start order
ensure ox_lib
ensure oxmysql
ensure [framework-resources]
ensure [inventory]
ensure [target]
ensure orbit-lib
# Start this afterward when selected as an interface provider.
ensure orbit-dynamichud-v2
# Start every other dependent Orbit resource last.
ensure orbit-craftingsystemFeature failure behavior
- A missing or mismatched framework can leave player, money, job, gang, and usable-item data unavailable.
- A missing inventory or target prevents the matching bridge from registering correctly.
- A missing notification provider logs an error and shows no notification.
- A missing progress provider logs an error and uses the cancellation callback when supplied.
- A missing Text UI provider returns
falsefrom show, hide, and status operations. - A missing skill-check provider returns
falseand can run the cancellation callback.
Resolve dependency and selector errors in Orbit Lib before debugging the dependent resource that called it.
Installation
Install Orbit Lib and connect Orbit resources to ESX, QB-Core, QBX, standalone, inventory, target, and interface providers.
Configuration
Complete orbit-lib config.lua reference for frameworks, standalone adapters, targets, inventories, notifications, progress bars, Text UI, and skill checks.