Orbit StudiosOrbit Studios
Orbit Studios Resourcesorbit-dynamichud-addons

Configuration

Configure orbit-dynamichud-addons keybinds, seatbelt behavior, cruise control, and notifications.

Configuration

All public configuration lives in resources/[orbit]/orbit-dynamichud-addons/config.lua.

This resource is client-heavy. Most settings affect how the local player toggles seatbelt or cruise control, what DynamicHUD receives through state bags, and when GTA's windscreen ejection behavior is allowed.

Avoid duplicate vehicle systems

Do not run two resources that both own seatbelt, ejection, or cruise-control state. Choose one owner and make any external harness integration publish LocalPlayer.state.harness.

File map

config.lua

Core settings

Prop

Type

resources/[orbit]/orbit-dynamichud-addons/config.lua
Config.Seatbelt = {
    enable = true,
    keybind = 'B',
    useMPH = false,
    minSpeedUnbuckled = 20.0,
    minSpeedBuckled = 160.0,
    harness = {
        disableFlyingThroughWindscreen = true,
        minSpeed = 200.0
    }
}

useMPH changes how minSpeedUnbuckled, minSpeedBuckled, and harness speed values are interpreted. Set it to true only when you want those thresholds written as miles per hour.

harness.disableFlyingThroughWindscreen = true prevents windscreen ejection while a harness is active. If you set it to false, harness.minSpeed becomes the ejection threshold while harnessed.

resources/[orbit]/orbit-dynamichud-addons/config.lua
Config.Cruise = {
    enable = true,
    keybind = 'Y'
}

Cruise can only enable when the player is driving, the vehicle is moving forward, and the vehicle class is supported by the client script.

resources/[orbit]/orbit-dynamichud-addons/config.lua
Config.Notify = function(message, type)
    TriggerEvent("orbit-dynamichud:notify", {
        description = message,
        type = type or 'info',
        duration = 3000
    })
end

Replace this function if you do not use DynamicHUD notifications. Keep it client-side and keep the (message, type) parameters so the seatbelt and cruise scripts can call it normally.

Locale text

The addon uses ox_lib locales. Set the locale in server.cfg, then edit the matching JSON file if you want different labels or messages.

server.cfg
setr ox:locale en
resources/[orbit]/orbit-dynamichud-addons/locales/en.json
{
  "actions": {
    "toggle_cruise_control": "Toggle Cruise Control"
  },
  "success": {
    "cruise_control_enabled": "Cruise control enabled"
  },
  "error": {
    "cruise_control_disabled": "Cruise control disabled",
    "cruise_control_unavailable": "Cruise control is not available for this vehicle"
  },
  "seatbelt_desc": "Toggle Seatbelt"
}

See Language Support for every included locale and the translation workflow.

Apply and verify

  1. Save config.lua and restart the addon.
  2. Reconnect the client when testing changed default keybinds because FiveM stores player overrides locally.
  3. Test seatbelt and cruise in a supported vehicle from the driver seat.
  4. Confirm LocalPlayer.state.seatbelt and LocalPlayer.state.cruise match the visible DynamicHUD indicators.
  5. Test unbuckled, buckled, and harness behavior at safe test speeds.
  6. Trigger each notification path and verify the active locale text.

On this page