Commands
Complete client and server command reference for orbit-dynamichud-v2.
Commands
Command names and help text come from locales/<locale>.json. This page uses the default English names. If a command value is translated, use that translated name in-game.
Client commands
Client commands are enabled individually in shared/config.lua:
Config.Commands = {
controlpanel = { enabled = true },
customize = { enabled = true },
music = { enabled = true },
carcontrol = { enabled = true },
settings = { enabled = true },
settingsshare = { enabled = true },
editmode = { enabled = true },
restarthud = { enabled = true },
engine = { enabled = true },
onboarding = { enabled = true }
}| Command | Parameters | Behavior |
|---|---|---|
/controlpanel | none | Opens the control panel when at least one panel module is enabled and onboarding is not active. |
/customize | none | Opens the Customize tab when it and at least one of its subtabs are enabled. |
/music | none | Opens the Music tab when it and at least one of its subtabs are enabled. |
/carcontrol | none | Opens Car Control when that tab is enabled and the player is in a vehicle. |
/settings | none | Opens the Settings tab when it and at least one of its subtabs are enabled. |
/settingsshare | none | Opens the standalone Settings Share page when it is enabled and settings are not locked. |
/editmode | none | Opens HUD edit mode when customization and the settings/edit-mode module are enabled and settings are not locked. |
/restarthud | none | Remounts the local UI, refreshes its configuration, and rebuilds map data without restarting the resource or discarding saved settings. |
/engine | none | Toggles the current vehicle engine while the player occupies the driver seat. |
/onboarding | none | Force-opens onboarding, including after completion, when onboarding is enabled and settings are not locked. |
Command switches and keybind switches are independent. Disabling /music, for example, does not disable an enabled Music keybind. Disabling the Music module prevents both entry points from registering or opening it.
Control-panel keybinds
Every control-panel keybind can be enabled and assigned independently:
Config.Keybinds.ui_keybinds = {
focus_ui = { enabled = true, key = 'F4' },
customize = { enabled = false, key = 'F5' },
music = { enabled = false, key = 'F6' },
carcontrol = { enabled = false, key = 'F7' },
settings = { enabled = false, key = 'F9' }
}focus_ui opens the normal/default control-panel page. The other entries open their named top-level tab. A keybind is registered only when its entry is enabled, its key is non-empty, and the target module is available. Car Control additionally checks that the player is currently in a vehicle when the key is pressed.
These are ox_lib keybind defaults. Players can remap registered bindings through FiveM settings. The legacy focus_ui = 'F4' form remains supported and is treated as enabled.
To open a specific control-panel page from another resource, use the openControlPanel event.
/onboarding is independent from Config.Onboarding.trigger: it works in both automatic and manual modes and does not start the first-run availability watcher. Disabling Config.Onboarding.enabled removes both the command and public event. Disabling only Config.Commands.onboarding.enabled leaves manual event integrations available. See the Onboarding guide.
Server commands
Server commands use ox_lib command registration and are configured in server/config.lua:
Config.Commands.cash = {
enabled = true,
allow = 'group.admin'
}
Config.Commands.bank = {
enabled = true,
allow = 'group.admin'
}
Config.Commands.setstress = {
enabled = true,
allow = 'group.admin'
}| Command | Parameters | Behavior |
|---|---|---|
/cash | [targetId] | Shows the caller's cash or a target player's cash. |
/bank | [targetId] | Shows the caller's bank balance or a target player's bank balance. |
/setstress | <amount> | Sets the caller's replicated stress value. |
/setstress | <targetId> <amount> | Sets a target player's replicated stress value. |
/cash
/cash 12
/bank
/bank 12
/setstress 25
/setstress 12 25Square brackets mean optional and angle brackets mean required. Stress is converted to a number and clamped between 0 and 100.
allow is passed to the ox_lib restricted command setting. An empty string makes the command unrestricted:
Config.Commands.cash = {
enabled = true,
allow = ''
}Framework account shape
The bundled cash and bank commands read QB/QBX-style Player.PlayerData.money.cash and Player.PlayerData.money.bank from the normalized orbit-lib player object. Disable or adapt these helper commands if your framework adapter does not expose that shape.
Locale keys
Every locale must preserve the command keys and descriptions:
{
"commands": {
"cash": "cash",
"bank": "bank",
"setstress": "setstress",
"engine": "engine",
"restarthud": "restarthud",
"onboarding": "onboarding",
"controlpanel": "controlpanel",
"customize": "customize",
"music": "music",
"carcontrol": "carcontrol",
"settings": "settings",
"settingsshare": "settingsshare",
"editmode": "editmode",
"desc": {
"cash": "Check Cash Balance",
"bank": "Check Bank Balance",
"setstress": "Sets your stress level, input should be 1-100.",
"engine": "Toggle vehicle engine",
"restarthud": "Restarts HUD",
"onboarding": "Enables onboarding again",
"controlpanel": "Open the HUD control panel",
"customize": "Open HUD customization",
"music": "Open HUD music controls",
"carcontrol": "Open vehicle controls",
"settings": "Open HUD settings",
"settingsshare": "Open the HUD settings sharing interface",
"editmode": "Open HUD edit mode"
}
}
}Restart the resource after changing command locale values or command configuration.