Configuration
Configure orbit-lib config.lua for framework, target, inventory, notifications, progress, and gang data.
Configuration
Edit resources/[orbit]/orbit-lib/config.lua.
orbit-lib is the bridge layer. Other Orbit resources call it when they need player data, inventory actions, item counts, notifications, progress bars, and framework-specific helpers. If a value here points at the wrong framework or resource name, the dependent resource usually fails later with missing exports, missing items, or empty player data.
Prop
Type
Framework Presets
Pick one framework preset first, then adjust the target, inventory, notification, and progress providers to match the resources actually started on your server.
Config.Framework = 'esx'
Config.TargetResource = 'ox_target'
Config.Inventory = 'ox_inventory'
Config.Notify = 'ox_lib'
Config.Progress = 'ox_lib'Config.Framework = 'qb'
Config.TargetResource = 'qb-target'
Config.Inventory = 'qb-inventory'
Config.Notify = 'framework'
Config.Progress = 'framework'Config.Framework = 'qbx'
Config.TargetResource = 'ox_target'
Config.Inventory = 'ox_inventory'
Config.Notify = 'ox_lib'
Config.Progress = 'ox_lib'Config.Framework = 'standalone'
Config.TargetResource = 'ox_target'
Config.Inventory = 'ox_inventory'
Config.Notify = 'ox_lib'
Config.Progress = 'ox_lib'
Config.Standalone = {
identifierType = 'license',
playerDataCache = 1000,
defaultMoney = {
cash = 0,
bank = 0,
dirty = 0
},
defaultJob = {
name = 'unemployed',
label = 'Unemployed',
grade = {
name = 'Unemployed',
level = 0
}
},
fetchName = nil,
fetchCharInfo = nil,
fetchMoney = nil,
fetchJob = nil,
createUsableItem = nil
}Supported Providers
These are the supported values from config.lua. Use the exact lowercase key in the config, not the display name.
| Config value | Use when |
|---|---|
esx | Your server runs ESX Legacy or another ESX-compatible setup. |
qb | Your server runs QBCore and exposes QB-style player data. |
qbx | Your server runs QBX/Qbox and uses QB-style data with modern Qbox resources. |
standalone | You do not use ESX, QB, or QBX and will provide standalone adapters where needed. |
Framework selection controls how orbit-lib reads player identifiers, names, character info, money, jobs, gangs, and usable-item behavior.
| Config value | Resource | GitHub |
|---|---|---|
ox_target | Overextended target system for entity, zone, and world interactions. | overextended/ox_target |
qb-target | QBCore target interaction system. | qbcore-framework/qb-target |
Target resources are used when Orbit resources create interaction points, such as crafting stations.
| Config value | Resource or mode | GitHub |
|---|---|---|
ox_inventory | Overextended inventory. Recommended for OX/QBX style servers. | overextended/ox_inventory |
qb-inventory | Official QBCore inventory. | qbcore-framework/qb-inventory |
ps-inventory | Project Sloth inventory. | Project-Sloth/ps-inventory |
lj-inventory | LJ inventory. | loljoshie/lj-inventory |
qb-like | Custom inventory with QB-style exports. | Custom resource |
ox-like | Custom inventory with OX-style exports. | Custom resource |
Inventory support is used for item counts, adding/removing items, metadata, image paths, and usable-item behavior. For qb-like or ox-like, set Config.CustomInventory to the actual resource name and Config.CustomExport only when the export name differs from the resource name.
| Config value | Provider | Use when |
|---|---|---|
framework | ESX/QB/QBX native notification wrapper. | You want Orbit resources to use your framework's normal notification behavior. |
ox_lib | lib.notify. | You have ox_lib installed and want consistent ox_lib notifications. |
orbit-dynamichud | DynamicHUD notification event. | You have orbit-dynamichud installed and want notifications shown through the HUD interface. |
Do not use orbit-dynamichud as the notification provider unless orbit-dynamichud is installed and started after orbit-lib.
| Config value | Provider | Use when |
|---|---|---|
framework | ESX/QB/QBX progress wrapper. | Your framework already provides a progress bar you want Orbit resources to use. |
ox_lib | lib.progressBar / lib.progressCircle. | You want progress handled by ox_lib. |
orbit-dynamichud | DynamicHUD interface integration. | You want Orbit resources to integrate progress UI through DynamicHUD where supported. |
Provider Rules
Use real resource names and supported provider keys:
Prop
Type
Do not set a provider to a resource that is not running. For example, Config.Notify = 'orbit-dynamichud' only makes sense when orbit-dynamichud is installed and started after orbit-lib.
Standalone Adapters
Standalone mode uses defaults until you provide adapters.
Prop
Type
The default standalone data is useful for testing, but production standalone servers usually need at least money and job adapters so HUDs, access checks, and logs show real values.
Config.Standalone.fetchMoney = function(source, playerState, defaults)
return {
cash = defaults.cash,
bank = defaults.bank,
dirty = defaults.dirty
}
endConfig.Standalone.fetchJob = function(source, playerState, defaults)
return {
name = defaults.name,
label = defaults.label,
grade = defaults.grade
}
endIf you use standalone mode with a custom inventory, implement createUsableItem only when another Orbit resource needs usable-item registration and your inventory does not already provide a native framework callback.
Custom Inventory
Use this only when the inventory follows a QB-like or OX-like export shape but runs under a custom resource name.
Config.Inventory = 'qb-like'
Config.CustomInventory = 'my_inventory'
Config.CustomExport = 'my_inventory'Set Config.CustomExport only when the export name is different from the resource name.