# Configuration

The main configuration file is `0r-hud-v3/config.lua`.

## Main Settings You Will Usually Change

| Field                                           | What it controls                                  |
| ----------------------------------------------- | ------------------------------------------------- |
| `Config.DefaultHudSettings.bar_style`           | Default bar style                                 |
| `Config.DefaultHudSettings.is_res_style_active` | Alternative bar ordering/layout                   |
| `Config.DefaultHudSettings.vehicle_hud_style`   | Default vehicle HUD preset                        |
| `Config.DefaultHudSettings.mini_map`            | Minimap style and only-in-vehicle behavior        |
| `Config.DefaultHudSettings.compass`             | Compass enable state and only-in-vehicle behavior |
| `Config.DefaultHudSettings.cinematic`           | Cinematic mode toggle                             |
| `Config.DefaultHudSettings.vehicle_info.kmH`    | KM/H or MPH                                       |
| `Config.DefaultHudSettings.client_info`         | Top-right info block visibility                   |
| `Config.DefaultHudSettings.music_info`          | Music widget toggle                               |
| `Config.DefaultHudSettings.navigation_widget`   | Navigation widget toggle                          |
| `Config.DefaultHudSettings.bar_colors`          | Default colors for each status bar                |
| `Config.MoneySettings`                          | Cash/account item handling and extra currency     |
| `Config.ToggleSettingsMenu`                     | HUD settings keybind and command                  |
| `Config.ToggleSeatBelt`                         | Seatbelt system and eject speed                   |
| `Config.ToggleVehicleEngine`                    | Engine toggle keybind                             |
| `Config.ToggleCinematicMode`                    | Cinematic mode command/keybind                    |
| `Config.ResetHudPositions`                      | Reset positions command                           |
| `Config.HideGTAHudComponents`                   | Hide GTA HUD pieces                               |
| `Config.HavePostalMap`                          | Postal map compatibility                          |
| `Config.RefreshTimes`                           | Refresh intervals                                 |
| `Config.BarColors`                              | Color picker palette                              |
| `Config.ElectricVehicles`                       | Vehicles that should use electric fuel display    |

## Default HUD Look

Most visual customization starts in `Config.DefaultHudSettings`.

The most commonly changed parts are:

* `bar_style`
* `vehicle_hud_style`
* `mini_map.style`
* `client_info.server_info.name`
* `client_info.server_info.image`
* `bar_colors`

If you want the default UI to match your server brand, start here first.

## Keybinds and Commands

The current HUD version uses these sections:

* `Config.ToggleSettingsMenu`
* `Config.ToggleSeatBelt`
* `Config.ToggleVehicleEngine`
* `Config.ToggleCinematicMode`
* `Config.ResetHudPositions`

That means the older docs based on `OpenSettingsKeybind` and `Commands.HudSettings` are outdated. Use the newer config sections above.

## Money and Extra Currency

If your cash is an item instead of framework money, edit:

```lua
Config.MoneySettings
```

You can also show one extra currency in the top-right info panel by using:

* item type
* account type

## Seatbelt and Vehicle Settings

Use these sections for vehicle related behavior:

* `Config.ToggleSeatBelt`
* `Config.ToggleVehicleEngine`
* `Config.ElectricVehicles`

Seatbelt eject speed is based on KM/H if `vehicle_info.kmH = true`.

## Colors

There are two color areas:

* `Config.DefaultHudSettings.bar_colors` for default bar assignments
* `Config.BarColors` for the color choices available in the settings menu

## Extra Data Files

These files also matter:

* `data/hud.lua` contains the default HUD data model and supported style aliases
* `data/weapons.lua` contains weapon display names used in the HUD

In most cases you should edit `config.lua` first and only touch these files if you specifically need to change defaults or weapon labels.

## Localization

This resource uses locale files in the `locales/` folder. The active language is controlled through `ox_lib`.

Example:

```cfg
set ox:locale "en"
```