> 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/installation.md).

# Installation

### Installation <a href="#izzy-hudv8-installation" id="izzy-hudv8-installation"></a>

1. Place the resource folder in your server `resources` directory (e.g. `resources/[hud]/izzy-hudv8`).
2. Add your server logo at `imgs/logo.png` (used by top bar; size configurable).
3. Ensure minimap textures exist under `stream/` if you use custom circle/square maps (`squaremap`, `circlemap` dicts).
4. In `server.cfg`:

```lua
ensure oxmysql          # if you use it elsewhere
ensure es_extended      # or qb-core
ensure izzy-hudv8
```

1. Open `shared/config.lua` and set at minimum:

| Property            | Description                                         |
| ------------------- | --------------------------------------------------- |
| IZZY.Framework      | `IZZY.Framework`                                    |
| IZZY.Locale         | `IZZY.Locale`                                       |
| IZZY.TopInformation | `IZZY.TopInformation` (server name, logo, currency) |

1. Restart the resource or server.

**Load order:** Start the HUD **after** your framework (`es_extended` / `qb-core`). Avoid running two HUD resources at once.

### Quick start <a href="#izzy-hudv8-installation-quick-start" id="izzy-hudv8-installation-quick-start"></a>

<mark style="color:$info;">Minimal steps to go live:</mark>

| Action              | Default                                         |
| ------------------- | ----------------------------------------------- |
| Open HUD settings   | `/hud` (command) or **F7** (if keybind enabled) |
| Toggle entire HUD   | `/hudonoff`                                     |
| Car control panel   | `/carcontrol` or **F10**                        |
| Vehicle music       | `/music` (vehicle only by default)              |
| Seatbelt            | **B** (when enabled)                            |
| Cancel progress bar | **DELETE** or `/cancel`                         |

Players can customize status style, speedometer, colors, minimap shape, and more from the in-game settings menu. First-join defaults are set in `IZZY.FirstLoginSetup`.


---

# 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/installation.md?ask=<question>&goal=<endgoal>
```

`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.