Orbit Studios Resourcesorbit-dynamichud-v2
Dependencies
Required and optional dependencies, start order, and feature-specific requirements for orbit-dynamichud-v2.
Dependencies
Required
| Dependency | Why it is needed | Link |
|---|---|---|
ox_lib | Cache helpers, locales, callbacks, keybinds, commands, and runtime utilities. | overextended/ox_lib |
orbit-lib | Normalized framework player/inventory data and Orbit resource integration. | orbit-lib docs |
| Supported framework | ESX, QB-Core, QBX, or the configured standalone adapter in orbit-lib. | orbit-lib configuration |
Required for Settings Share
| Dependency | Why it is needed | Link |
|---|---|---|
oxmysql | Stores presets, likes, downloads, ownership, moderation state, and metadata. | overextended/oxmysql |
Settings Share is enabled by default. If it remains enabled, oxmysql must start before DynamicHUD and its Lua library must be loaded in the manifest.
dependency 'oxmysql'
server_script '@oxmysql/lib/MySQL.lua'Optional integrations
| Dependency | Feature |
|---|---|
screenshot-basic | One supported Settings Share capture provider. Install it only when selected in captureProvider. |
screencapture | Alternative Settings Share capture provider. Install it only when selected in captureProvider. |
| FiveManage API key | Hosts uploaded preset screenshots through a server-requested presigned URL. |
orbit-dynamichud-addons | Orbit seatbelt and cruise-control integration. |
orbit-dynamichud-stress | Replicated stress gain, relief, and effects. |
pma-voice | Voice/radio state on servers using pma-voice. |
| Supported inventory | Inventory-backed ammo, item counts, and inventory-open state. |
| Custom fuel resource | Fuel values through Config.GetVehicleFuelLevel. |
See Settings Sharing before enabling screenshots, then follow FiveManage Setup to create and secure the API key. Keep the key in a server convar, never in shared/client code.
Start order
ensure ox_lib
ensure oxmysql
ensure [framework-resources]
ensure [inventory]
ensure orbit-lib
# Only required when preset screenshots are enabled. Start the provider
# selected by Config.SettingsShareServer.thumbnail.captureProvider.
ensure screencapture
# ensure screenshot-basic
ensure orbit-dynamichud-v2
# Optional integrations
ensure orbit-dynamichud-addons
ensure orbit-dynamichud-stressThe selected framework must be available before orbit-lib. Start optional state providers after the base HUD unless their own documentation requires otherwise.
Feature failure behavior
- Missing
ox_libcallbacks prevent Settings Share initialization. - Missing
oxmysqlprevents Settings Share initialization but should not be treated as a valid production setup when the feature is enabled. - A missing/mismatched capture provider or missing API credentials disables custom screenshot capture; preset uploads can continue with fallback previews.
- Setting
music.onlyLocalMusic = trueavoids all server-side dynamic-sound work and does not need an external audio resource.