# Installation (/docs/orbit-studios-resources/orbit-dynamichud-v2)



# Orbit Dynamic HUD 2.0 [#orbit-dynamic-hud-20]

Orbit Dynamic HUD 2.0 is a configurable FiveM HUD with status variants, player information, Dynamic Bar/widgets, speedometers, vehicle controls, music, reusable interface APIs, edit mode, and database-backed settings presets.

<Callout type="warn" title="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.
</Callout>

<Callout type="info" title="Resource name and event namespace">
  Use `orbit-dynamichud-v2` for the folder, `ensure` entry, exports, Orbit Lib provider selectors, and documentation URL. The v2 resource currently retains `orbit-dynamichud:*` for its public event namespace; copy those event names exactly as documented.
</Callout>

<Cards>
  <Card title="Dependencies" description="Required resources, optional integrations, and correct start order." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/dependencies" />

  <Card title="Configuration" description="Runtime behavior, modules, defaults, layouts, weapons, and integrations." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/configuration" />

  <Card title="Onboarding" description="Automatic, manual, and disabled modes with integration examples." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/onboarding" />

  <Card title="Settings Sharing" description="Database presets, private codes, discovery, moderation, security, and thumbnails." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/settings-sharing" />

  <Card title="FiveManage Setup" description="Create a secure API key and configure preset thumbnail uploads." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/fivemanage" />

  <Card title="Interface APIs" description="Notifications, Text UI, skill checks, and progress bars." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/interface" />

  <Card title="Exports" description="Complete client and server export reference." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/exports" />

  <Card title="Events and State Bags" description="Supported events, navigation IDs, phone hooks, and gameplay state." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/events" />

  <Card title="Commands" description="All localized client and restricted server commands." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/commands" />

  <Card title="Language Support" description="Available locales and translation workflow." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/language-support" />

  <Card title="Troubleshooting" description="Resolve startup, framework, NUI, Settings Share, audio, and vehicle issues." href="/docs/orbit-studios-resources/orbit-dynamichud-v2/troubleshooting" />
</Cards>

## Installation [#installation]

1. Download the release from the Cfx.re Portal account that owns the license.
2. Stop the server before installing or replacing resource files.
3. Extract the folder as `orbit-dynamichud-v2` without an extra nested directory.
4. Install `ox_lib`, the included `orbit-lib`, and `oxmysql` when Settings Share is enabled.
5. Configure `orbit-lib` for ESX, QB-Core, QBX, or standalone mode.
6. Review `shared/config.lua`, `shared/settingsConfig.lua`, and `server/config.lua`.
7. Start resources in dependency order.
8. Restart the server and join after framework player data has loaded.

```properties title="server.cfg"
ensure ox_lib
ensure oxmysql
ensure [framework-resources]
ensure [inventory]
ensure orbit-lib
ensure orbit-dynamichud-v2
```

The purchased release includes its compiled NUI; no frontend build step is required.

## Resource structure [#resource-structure]

<Files>
  <Folder name="orbit-dynamichud-v2">
    <File name="fxmanifest.lua" />

    <Folder name="shared">
      <File name="config.lua" />

      <File name="settingsConfig.lua" />

      <File name="weapons.lua" />

      <File name="cars.lua" />
    </Folder>

    <Folder name="client">
      <File name="main.lua" />

      <File name="nui.lua" />

      <File name="focus.lua" />

      <File name="car.lua" />

      <File name="sounds.lua" />

      <File name="settingsShare.lua" />

      <File name="postals.lua" />

      <File name="translations.lua" />

      <Folder name="interface">
        <File name="notifications.lua" />

        <File name="textui.lua" />

        <File name="skillcheck.lua" />

        <File name="progressbar.lua" />
      </Folder>
    </Folder>

    <Folder name="server">
      <File name="config.lua" />

      <File name="handlers.lua" />

      <File name="main.lua" />

      <File name="sounds.lua" />

      <File name="settingsShare.lua" />
    </Folder>

    <Folder name="locales">
      <File name="en.json" />

      <File name="de.json" />

      <File name="es.json" />

      <File name="fr.json" />

      <File name="sv.json" />

      <File name="tr.json" />
    </Folder>
  </Folder>
</Files>

Only edit documented public configuration, handler, weapon, car, and locale files. Runtime files are shown so server owners can verify that the release is complete; they are not an invitation to modify escrowed code.

## Framework setup [#framework-setup]

<Tabs groupId="framework" items="['ESX', 'QB-Core', 'QBX', 'Standalone']">
  <Tab value="ESX">
    Configure ESX in `orbit-lib`. DynamicHUD 2.0 listens for ESX account/status/spawn events and the default handlers include ESX death-state support. Adapt `server/handlers.lua` if the medical or inventory resource uses different events.
  </Tab>

  <Tab value="QB-Core">
    Configure QB-Core in `orbit-lib`. DynamicHUD 2.0 supports common QB money, needs, stress, player-loaded, hospital, seatbelt, cruise, and nitrous compatibility events.
  </Tab>

  <Tab value="QBX">
    Configure QBX in `orbit-lib`. DynamicHUD 2.0 accepts common QB HUD events and QBX state bags such as medical death state and vehicle nitrous state.
  </Tab>

  <Tab value="Standalone">
    Configure the standalone adapter in `orbit-lib`, then trigger `orbit-dynamichud:standalone:playerLoaded` after login and publish the documented player state bags from your resources.
  </Tab>
</Tabs>

## First-run verification [#first-run-verification]

1. Confirm no dependency, locale, database, or framework errors appear in either console.
2. Join with a fully loaded character and complete onboarding, or trigger it from your integration when manual mode is enabled.
3. Verify health, armor, needs, money, job, player count, and profile information.
4. Run `/controlpanel`, `/editmode`, and `/restarthud` if those commands are enabled.
5. Enter each supported vehicle type and verify speed, fuel, RPM, seatbelt, cruise, nitrous, and car control as applicable.
6. Test a notification, Text UI, skill check, and progress bar from a development resource.
7. Open `/settingsshare`, save a private preset, and test configured discovery/moderation features.
8. Verify the HUD hides/shows correctly with inventory, pause menu, death, and phone flows.

## Optional Orbit resources [#optional-orbit-resources]

* [Orbit DynamicHUD Addons](/docs/orbit-studios-resources/orbit-dynamichud-addons) for Orbit seatbelt/cruise integration
* [Orbit DynamicHUD Stress](/docs/orbit-studios-resources/orbit-dynamichud-stress) for stress gameplay and effects

## Support [#support]

When requesting support, include the client/server console error, framework and inventory names, relevant config 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.