Configuration

Edit resources/[orbit]/orbit-lib/config.lua. This is the only orbit-lib file server owners should modify.

Each selector tells all dependent Orbit resources which integration to call. Values are case-sensitive and must match the keys documented below. After changing a selector or adapter, restart orbit-lib and every resource that depends on it.

File map

Configuration map

Config.Debug and Config.Gangs are not valid settings. Use Config.CustomGang for the optional custom gang adapter.

Full config file

The current public config has this overall structure. Choose values that match the resources installed on your server; do not blindly keep the example selections.

Config = {}

-- Supported frameworks: qb, esx, qbx, standalone
Config.Framework = 'qbx'

-- Used only when Config.Framework is 'standalone'.
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
}

-- Optional custom gang data for ESX and standalone.
Config.CustomGang = {
    enabled = false,
    fetchGang = function(playerState, source)
        return {
            name = playerState.gangName or '',
            label = playerState.gangName or '',
            grade = {
                name = playerState.gangRankName or '',
                level = 1
            }
        }
    end
}

Config.TargetResource = 'ox_target'
Config.Inventory = 'ox_inventory'

-- Used only with qb-like or ox-like.
Config.CustomInventory = ''
Config.CustomExport = ''

Config.Notify = 'orbit-dynamichud'
Config.Progress = 'orbit-dynamichud'
Config.TextUI = 'orbit-dynamichud'
Config.SkillCheck = 'orbit-dynamichud'

Framework presets

Select the tab for your framework. The target and inventory pair shown is a common starting point, not a requirement; change either when your server uses another supported resource.

Config.Framework = 'esx'
Config.TargetResource = 'ox_target'
Config.Inventory = 'ox_inventory'

Config.Framework = 'qb'
Config.TargetResource = 'qb-target'
Config.Inventory = 'qb-inventory'

Config.Framework = 'qbx'
Config.TargetResource = 'ox_target'
Config.Inventory = 'ox_inventory'

Config.Framework = 'standalone'
Config.TargetResource = 'ox_target'
Config.Inventory = 'ox_inventory'

Interface providers

The four interface selectors are independent. For example, a server can use Orbit Dynamic HUD 2.0 notifications and Text UI while keeping ox_lib progress bars and skill checks.

Config.Notify = 'orbit-dynamichud'
Config.Progress = 'orbit-dynamichud'
Config.TextUI = 'orbit-dynamichud'
Config.SkillCheck = 'orbit-dynamichud'

Config.Notify = 'ox_lib'
Config.Progress = 'ox_lib'
Config.TextUI = 'ox_lib'
Config.SkillCheck = 'ox_lib'

Config.Notify = 'framework'
Config.Progress = 'framework'
Config.TextUI = 'ox_lib'
Config.SkillCheck = 'ox_lib'

Targets

Config.TargetResource = 'ox_target'

The selected target resource must start before orbit-lib. Restart dependent resources after switching target systems so their interactions are registered again.

Inventories

For a built-in inventory, leave both custom values empty:

Config.Inventory = 'ox_inventory'
Config.CustomInventory = ''
Config.CustomExport = ''

For a compatible custom inventory, select its API family and provide its real resource name:

Config.Inventory = 'ox-like'
Config.CustomInventory = 'my_inventory'
Config.CustomExport = ''

Config.CustomExport is normally empty. Set it only when the name used in exports[...] differs from the folder/resource name:

Config.Inventory = 'qb-like'
Config.CustomInventory = 'custom_inventory_resource'
Config.CustomExport = 'inventory_api'

Selecting qb-like or ox-like does not make an arbitrary inventory compatible. Its exports and argument/return shapes must match the corresponding built-in bridge.

Standalone mode

Standalone mode builds normalized player data without ESX, QB, or QBX. Defaults keep calls from failing, but production servers should replace placeholder money, job, and character data with adapters tied to their own systems.

Use the provided defaults as a safe base and return the same data shape:

Config.Standalone.fetchMoney = function(source, playerState, defaults)
    defaults.cash = playerState.cash or 0
    defaults.bank = playerState.bank or 0
    defaults.dirty = playerState.dirtyMoney or 0
    return defaults
end

Config.Standalone.fetchJob = function(source, playerState, defaults)
    defaults.name = playerState.jobName or 'unemployed'
    defaults.label = playerState.jobLabel or 'Unemployed'
    defaults.grade = {
        name = playerState.jobGradeName or 'Unemployed',
        level = playerState.jobGrade or 0
    }
    return defaults
end

Adapter failures are caught and logged by name. When an adapter returns nil or fails, orbit-lib uses its configured/default fallback value.

Custom gang data

Config.CustomGang is read only by ESX and standalone bridges. QB and QBX already obtain gang data from their framework player data.

Config.CustomGang = {
    enabled = true,
    fetchGang = function(playerState, source)
        return {
            name = playerState.gangName or '',
            label = playerState.gangLabel or playerState.gangName or '',
            grade = {
                name = playerState.gangRankName or '',
                level = playerState.gangRank or 0
            }
        }
    end
}

Leave enabled = false when your Orbit resources do not use a custom gang system. The callback must return a gang table with name, label, and grade when enabled.

Apply and verify

1. Save resources/[orbit]/orbit-lib/config.lua.
2. Confirm ox_lib, oxmysql, the selected framework, inventory, and target have started.
3. Start or restart orbit-lib.
4. Start or restart Orbit Dynamic HUD 2.0 if any interface selector uses it.
5. Restart every dependent Orbit resource so it reloads the bridge selection.
6. Test one inventory action, target interaction, notification, progress bar, Text UI prompt, and skill check used by your installed resources.