> For the complete documentation index, see [llms.txt](https://kazescripts.gitbook.io/kazescripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kazescripts.gitbook.io/kazescripts/kaze_hud/configuration.md).

# Configuration

Every option in config.lua, with its default value.

All server options are in `config.lua`. Players change their own look in game, so this file only holds server-wide settings.

## Framework

```lua
Config.Framework = 'auto'
```

`'auto'` picks the running framework. Force one with `'qbox'`, `'qbcore'`, `'esx'` or `'standalone'`.

## Commands and key

```lua
Config.Commands = {
    settings = 'hud',
    cinematic = 'cinematic',
}

Config.SettingsKey = 'I'
```

| Option               | Default     | What it does                                                                             |
| -------------------- | ----------- | ---------------------------------------------------------------------------------------- |
| `Commands.settings`  | `hud`       | Command that opens the HUD editor                                                        |
| `Commands.cinematic` | `cinematic` | Command that toggles cinematic mode                                                      |
| `SettingsKey`        | `I`         | Default key for the editor. Players can rebind it in **Settings > Key Bindings > FiveM** |

## Update rates

```lua
Config.Rates = {
    status = 250,
    vehicle = 80,
    heading = 60,
    street = 500,
    info = 1000,
    weapon = 120,
}
```

How often each part reads the game, in milliseconds. Lower is smoother, higher uses less CPU. The defaults are a good balance.

| Key       | Reads                          |
| --------- | ------------------------------ |
| `status`  | Health, armor, needs and voice |
| `vehicle` | Speed, RPM and gear            |
| `heading` | Compass                        |
| `street`  | Street and area names          |
| `info`    | Money, job, time and players   |
| `weapon`  | Ammo                           |

## Minimap

```lua
Config.MinimapOnlyInVehicle = true
Config.MinimapZoom = 1100
```

| Option                 | Default | What it does                               |
| ---------------------- | ------- | ------------------------------------------ |
| `MinimapOnlyInVehicle` | `true`  | Show the minimap only in a vehicle         |
| `MinimapZoom`          | `1100`  | Minimap zoom. Higher shows more of the map |

## Hidden GTA HUD parts

```lua
Config.HideHudComponents = { 1, 2, 3, 4, 6, 7, 8, 9, 13, 17, 20 }
```

GTA HUD components hidden every frame, because kaze\_hud replaces them: wanted stars, weapon icon, cash, vehicle name, area name, vehicle class, street name, cash change, save icon and weapon stats. Remove a number to bring that GTA part back.

## Dirty money

```lua
Config.DirtyMoneyItem = 'black_money'
```

Item counted as dirty money in the player info block. Set it to `false` to never show dirty money. On ESX the `black_money` account is used.

## Extra weapons

```lua
Config.ExtraWeapons = {
    [`WEAPON_MYGUN`] = { name = 'WEAPON_MYGUN', label = 'My Gun' },
}
```

Names for add-on weapons your inventory does not know.

## Indicators

```lua
Config.Indicators = { Left = 'LEFT', Right = 'RIGHT', Hazard = 'DOWN' }
```

Default keys for the left indicator, right indicator and hazard lights. Players can rebind them in the FiveM key bindings.