Installation
Install orbit-dynamichud and prepare HUD settings, DynamicBar, commands, exports, notifications, weapons, and server handlers.
Installation
orbit-dynamichud is Orbit Studios' interactive FiveM HUD with customizable status UI, speedometers, DynamicBar, car controls, music, notifications, commands, and state-bag integrations.
Required order
Start orbit-lib and ox_lib before orbit-dynamichud.
Use this page to install the base HUD. Seatbelt, cruise control, and stress are separate resources so you can decide whether to use the Orbit addons or wire in your own existing systems.
Dependencies
Required resources and optional stress, seatbelt, voice, radio, and inventory integrations.
Configuration
HUD behavior, player defaults, server commands, handlers, weapons, and locales.
Interface
Notifications, TextUI, skill check, and progress bar integration notes.
Exports
HUD state exports, toggle export, and server/client events.
Commands
HUD restart, engine, onboarding, and money/stress commands.
Language Support
Available locale files and ox_lib locale setup.
Stress Addon
Install the dedicated stress resource for stress gain, relief, effects, and state bags.
Troubleshooting
Fix HUD visibility, needs, stress, money, notifications, and vehicle UI issues.
File Structure
What You Edit
The base HUD has several public config files. Start with these before touching custom integrations:
Use shared/config.lua for visible HUD features, update intervals, DynamicBar, and enabled status values. Use settingsConfig.lua for the default HUD preset a new player receives. Use server/handlers.lua only when you need to adapt money, death, inventory-open, or framework-specific state events.
Installation
ensure ox_lib
ensure [framework-resources]
ensure orbit-lib
ensure orbit-dynamichudInstall the optional addon resources after the base HUD:
ensure orbit-dynamichud-addons
ensure orbit-dynamichud-stressAfter joining the server, use /restarthud once and confirm that health, armor, hunger, thirst, and vehicle UI values update before adding custom integrations.
Framework Notes
ESX money updates are handled through esx:setAccountMoney. Death state can be set through ESX death and spawn handlers.
QB uses QBCore player-loaded, money-change, needs, and stress events.
QBX works through QB-style HUD events plus normalized player data from orbit-lib.
Use Config.Framework = 'standalone' in orbit-lib. DynamicHUD reads normalized player data from orbit-lib; configure standalone money/job adapters there when the default values are not enough.