# Admin HUD (/docs/orbit-studios-resources/orbit-dynamichud-v2/admin-hud)



# Admin HUD [#admin-hud]

The Admin HUD is an optional ACE-gated editor for the serializable values in `shared/config.lua`, `shared/settingsConfig.lua`, and non-secret settings in `server/config.lua`. It uses the HUD's dark interface and is separate from the player control panel.

```lua title="resources/[orbit]/orbit-dynamichud-v2/server/config.lua"
Config.AdminHud = {
    enabled = true,
    ace = "orbit.adminhud",
    command = "adminhud",
}
```

```properties title="server.cfg"
add_ace group.admin orbit.adminhud allow
```

An authorized player can enter `/adminhud`. The server checks the ACE both when opening the page and on **every** read, save, reset, and player action. Set `enabled = false` in `server/config.lua` to disable the command and handlers, even if an old saved override says otherwise. `command` accepts a single command name without `/`, spaces, or punctuation other than `_`. Changes to this block require a resource restart; if the Admin HUD was disabled through its own editor, remove the saved override from `shared/admin-overrides.json` before restarting.

On the localhost Vite preview, the development debug panel has an **Admin HUD** button. It opens sample settings so you can inspect the layout and edit controls. Save, reset, and player actions are simulated locally; they do not contact a FiveM server or change its configuration.

## Editing config [#editing-config]

Choose a section on the left, or search by a setting's label or config key. Search results open the matching field. **Changed only** filters to your pending edits, and the undo icon beside a changed field restores its last saved value. Select **Save config** to validate and write changes to `shared/admin-overrides.json`.

Fields marked **Requires restart** are saved but do not take effect immediately. The same badge appears in search results; hover it for an explanation. The badges follow the server's live-update support list.

These settings apply immediately to connected players, without restarting the resource:

* `Debug`, `MoneyText`, `HeadingType`, and `DriverPermissionAsPassenger`.
* `EnabledValues`, `CinematicHeight`, and `PerformanceSettings`.
* `DefaultSettings`, including locked layouts and visibility policies. Unlocked player preferences are preserved; changing defaults does not force every player to use them. Use **Force HUD settings** for that.
* `ControlPanel.customize`, `ControlPanel.settings`, and `ControlPanel.carControl`.

Players who join later receive the same live configuration. In the editor, **supported settings** means exactly the live list above, not every setting the editor can save.

### Settings that require a restart [#settings-that-require-a-restart]

These editable sections are saved now but only activated after restarting `orbit-dynamichud-v2`:

| Config section                                       | Why it is not applied live                                                                                                                                                             |
| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Commands`, `Keybinds`, server `commands`            | Commands, chat suggestions, and key mappings are registered during startup. Changing a value alone would not replace the existing registrations.                                       |
| `Onboarding`                                         | The trigger policy is resolved once, and automatic onboarding and command registration depend on that initial policy.                                                                  |
| `WaypointNavigation`                                 | The navigation worker and its cached options are initialized at startup.                                                                                                               |
| `CustomLocationNames`                                | Street and zone replacements are registered with GTA once. Live changes would also need to restore removed replacements.                                                               |
| `PhoneOffset`                                        | The side, distance, and enabled state are cached, and the configured phone events are registered once.                                                                                 |
| `DynamicBar`                                         | Mode policy and postal support are initialized at startup. Changing the table alone would leave those cached decisions unchanged.                                                      |
| `CustomMap`                                          | The radar worker's lifecycle depends on the startup configuration; a stopped worker is not automatically recreated.                                                                    |
| `Accounts`                                           | Money update handling is registered conditionally when the resource starts.                                                                                                            |
| `SettingsLocked`                                     | Several commands and services are conditionally registered or skipped based on the initial lock state. This differs from the live layout locks inside `DefaultSettings`.               |
| `ControlPanel.enableControlPanel`                    | The master panel switch is not included in the supported live-update list. It remains staged; changing this switch live would need to handle any already-open panel and its NUI focus. |
| `ControlPanel.music`                                 | Music services cache feature flags and initialize playback/synchronization workers from their startup options.                                                                         |
| `ControlPanel.settingsShare`, server `settingsShare` | Sharing handlers, feature flags, limits, and thumbnail settings are initialized together at startup.                                                                                   |
| Server `adminHud`                                    | The command, enabled state, and ACE permission are captured when the admin service starts.                                                                                             |

This is a boundary of the current implementation, not a FiveM restriction that makes live updates impossible. Supporting these sections live would require explicit cleanup and reinitialization of their registrations, workers, and cached state. They are staged together to avoid partially applying a change while an old service remains active.

When a save contains both kinds of changes, supported values apply immediately and the editor reports that some startup changes remain pending. Restart `orbit-dynamichud-v2` when ready to activate those remaining changes. **Reload** is not a substitute for that restart.

**Reset overrides** removes saved overrides after confirmation. Supported live settings revert immediately; any startup differences still need a restart. **Reload** fetches the latest saved configuration into the editor. It does not restart the resource or apply unsaved edits, and asks before discarding pending edits. If another admin saved while you were editing, reload before saving again.

The editor intentionally does not expose Lua functions or server-only secrets such as the FiveManage API key and upload endpoints. Edit those directly in their Lua files. The override JSON is written by the server and synced to clients so shared config changes can apply on both sides; do not put secrets in it or distribute it as a replacement for your config files. Keep `shared/admin-overrides.json` writable by the resource if you want in-game saves.

## Forcing player settings [#forcing-player-settings]

Open **Force HUD settings** and choose **One player** or **Everyone**. For one player, enter their **server ID**. Select **My current HUD** or **Configured server defaults**, then choose **Force settings**. For everyone, **Force everyone** requires a second confirmation. The server validates the submitted structure and preserves server-locked layouts and visibility policy. This affects connected players immediately and players who join while the global override is active.

**Clear override** restores one player's regular settings, or the global override if one is active. **Clear everyone** removes every forced setting, including individual overrides. Global overrides end when the resource restarts. Individual overrides also end when the player disconnects. None are saved to the config JSON.

Forcing settings does not change the server's default configuration. Test changes with a player first, then save the desired server defaults separately if they should persist.

The **Street Names** section also contains game zone aliases because GTA can use them in other on-screen labels. The Orbit HUD itself displays street names, not zone names.
