> For the complete documentation index, see [llms.txt](https://izzyshop-1.gitbook.io/izzyshop-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://izzyshop-1.gitbook.io/izzyshop-docs/hud-resources/hud-v8/configuration.md).
# Configuration
#### Config reference (`shared/config.lua`)
| Option | |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| IZZY.Locale | UI language: `en`, `tr`, `es`, `pt-br`, `de`, `fr`, `ru`, `zh-cn`, `th`, `ar`, `ja`, `ko`, `it`, `pl`, `uk`, `fa`, `id`, `vi`, `nl` |
| IZZY.Framework | `newqb` , `qbox`, `oldqb` , `esx` , `oldesx` |
| IZZY.DevMode | `true` = debug prints + `/izzyhudtestexports` export self-test |
| IZZY.Mysql | `oxmysql` , `ghmattimysql` , `mysql-async` |
#### Framework
`IZZY.Framework` is normalized at runtime:
| Property | Description |
| -------- | ------------------------------------------- |
| newqb | `newqb`, `qbox`, `oldqb`, `qbcore` → **qb** |
| oldesx | `oldesx` → **esx** |
Hunger/thirst:
| Property | Description |
| ---------- | ------------------------------------------------------- |
| **QBCore** | `metadata.hunger`, `metadata.thirst`, `metadata.stress` |
| **ESX** | `esx_status:onTick` (`hunger`, `thirst`, etc.) |
#### Keybinds & HUD menu (`IZZY.Keybinds`)
```lua
IZZY.Keybinds = {
hudMenuKey = {
enable = false, -- true = register F7 (or defaultKey)
defaultKey = 'F7',
description = 'izzy-hud - Settings Menu',
},
hudMenuCommand = {
enable = true,
name = 'hud', -- chat command to open settings
},
hudMenuBackgroundBlur = true,
}
```
#### First login defaults (`IZZY.FirstLoginSetup`)
Applied when a player has no saved HUD settings:
| Field | Values |
| -------------- | -------------------------------------------- |
| statusVariant | 1–18 (status HUD style) |
| speedoVariant | 1–12 (speedometer style) |
| topBarVariant | 1–7 (top bar style) |
| progbarVariant | 1–6 (progress bar style) |
| presentation | general , modern , classic mode |
| minimapShape | `circle` , `square` (classic/modern layouts) |
#### Streamer mode (`IZZY.StreamerMode`)
Hides sensitive top-bar fields when streamer mode is on (toggle in HUD menu if `allowToggle = true`):
#### Colors (`IZZY.Colors`)
Theme colors for top bar, notifications, progress bar, and settings menu. Adjust hex/rgba values to match your server brand.
#### Time display (`IZZY.TimeDisplay`)
| Option | Description |
| ------ | ----------------------------------------------------------------------------------------------------------------------------- |
| mode | `real` = real-world clock; `game` = in-game time |
| preset | Timezone when `mode = 'real'`: `istanbul`, `paris`, `london`, `berlin`, `new_york`, `los_angeles`, `tokyo`, `dubai`, `moscow` |
#### Minimap (`IZZY.Minimap`)
| `enable` | Master switch |
| ------------------- | --------------------------------------------------------------------- |
| `onlyInVehicle` | Show minimap only while in a vehicle |
| `useReplaceTexture` | Use custom `squaremap` / `circlemap` textures |
| `hideNorthBlip` | Hide north indicator on minimap |
| `mapUpByStatus` | Per status-variant vertical offset (when `followStatusMapUp` is used) |
#### Top bar / server info (`IZZY.TopBar`, `IZZY.TopInformation`)
```lua
IZZY.TopInformation = {
show = true,
style = 1,
logo = 'imgs/logo.png',
logo_width = 50,
logo_height = 50,
name = 'IZZY.RP',
role = 'Shop',
currency = '$',
showMoneyDecimals = false, -- true = 1.235,00 | false = no decimals (1.235)
cash = {
useItem = false, -- true = inventory item | false = ESX / QB / QBox account
itemName = 'money', -- when useItem = true → ox_inventory / ESX / QB item name
},
blackMoney = {
enable = true,
useItem = false, -- true = inventory item | false = account (ESX/QB — like cash/bank)
itemName = 'black_money', -- when useItem = true → ox_inventory / ESX inventory / QB item
accountName = 'black_money', -- when useItem = false → ESX account / QB money key
},
showType = {
showName = true,
showCash = true,
showBank = true,
showJob = true,
showWeapon = true,
showTotalPlayer = true,
showLogo = true,
},
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://izzyshop-1.gitbook.io/izzyshop-docs/hud-resources/hud-v8/configuration.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.