Installation
Install Orbit Lib and connect Orbit resources to ESX, QB-Core, QBX, standalone, inventory, target, and interface providers.
Orbit Lib
Orbit Lib is the required bridge library for Orbit Studios resources. It gives those resources one consistent connection to your framework, inventory, target system, notifications, progress bar, Text UI, skill checks, and optional custom gang data.
Official purchase required
Install and use this resource only when it was obtained for your account through the official Cfx.re Portal. Support requires both the matching Cfx.re Portal entitlement and the original Tebex purchase ID; a Portal entitlement by itself is not sufficient proof of purchase. Copies from Discord, leaked packs, file-sharing sites, source repositories, or another customer are unauthorized and unsupported.
Dependencies
Required libraries, selected bridge resources, and correct start order.
Configuration
Every supported framework, inventory, target, and interface selector in config.lua.
Troubleshooting
Resolve startup order, bridge selection, standalone adapter, and provider problems.
Installation
- Download the current release from the Cfx.re Portal account that owns the license.
- Stop the server before installing or replacing the resource.
- Extract the folder as
orbit-libwithout an extra nested directory. - Install
ox_libandoxmysql, then install the framework, inventory, and target resources selected inconfig.lua. - Edit only
resources/[orbit]/orbit-lib/config.luaand select integrations that are actually installed. - Start the selected dependencies before
orbit-liband all dependent Orbit resources afterward. - Restart the server after replacing an existing version so every dependent resource loads the same bridge version.
ensure ox_lib
ensure oxmysql
ensure [framework-resources]
ensure [inventory]
ensure [target]
ensure orbit-lib
# Dependent Orbit resources start afterward.
ensure orbit-dynamichud-v2
ensure orbit-craftingsystemOrbit Dynamic HUD 2.0 is the exception to normal provider ordering: it depends on Orbit Lib, so it starts afterward even when a UI selector uses orbit-dynamichud. The HUD must be fully started before another resource calls that interface.
Resource structure
Only edit resources/[orbit]/orbit-lib/config.lua. Do not rename the resource folder, move internal files, or modify escrowed files. Runtime folders are shown only so you can verify that the release extracted correctly.
Framework setup
Set Config.Framework = 'esx'. Orbit Lib reads ESX player and account data and registers usable items through ESX. Start es_extended before Orbit Lib.
Set Config.Framework = 'qb'. Orbit Lib uses qb-core player data, jobs, gangs, notifications, and usable-item registration. Start qb-core before Orbit Lib.
Set Config.Framework = 'qbx'. QBX servers normally pair qbx_core with ox_inventory, ox_target, and ox_lib interface providers.
Set Config.Framework = 'standalone'. Configure Config.Standalone adapters so dependent resources receive real character, money, job, and usable-item data instead of fallback values.
First-run verification
- Confirm
ox_lib,oxmysql, the selected framework, inventory, and target start without errors. - Confirm
orbit-libstarts before every dependent Orbit resource. - Join with a fully loaded character and verify dependent resources receive the correct name, job, money, and inventory data.
- Test one target interaction and one inventory action from an installed Orbit resource.
- Test every selected interface provider: notification, progress bar, Text UI, and skill check.
- Resolve the first
Unmatching ... Resourcemessage before testing later integrations.
Dependent Orbit resources
- Orbit Dynamic HUD 2.0 uses normalized player data and can provide all four interface bridges.
- Orbit Crafting System uses framework, inventory, target, notification, progress, player, and item bridges.
Support
When requesting support, include the client/server console error, framework, inventory, target, all four interface selector values, relevant config.lua section, reproduction steps, the matching Cfx.re Portal entitlement, and the original Tebex purchase ID. Both purchase records are required. Never post the complete paid resource publicly.