# LuaLab-HUD

## LuaLab HUD - Installation & Setup Guide

### Prerequisites

Before installing LuaLab HUD, ensure you have the following:

* FiveM Server with QBCore Framework
* pma-voice installed and configured
* LegacyFuel installed and configured

### Installation Steps

#### 1. Download & Extract

1. Download the latest release from the repository
2. Extract the `lualab-hud` folder to your server's resources directory
3. Ensure the folder structure matches:

#### 2. Configure Dependencies

Ensure your server.cfg has the following entries in the correct order:

```cfg
ensure qb-core
ensure LegacyFuel
ensure pma-voice
ensure LuaLab-HUD
```

#### 3. Configuration

1. Open `config.lua` to customize the HUD settings
2. Key settings can be modified:

```lua
Config.Keys = {
    seatbelt = 'K',
    cruise = 'Y',
    headlights = 'H'
}
```

3. Update intervals can be adjusted:

```lua
Config.UpdateIntervals = {
    hud = 200,
    vehicle = 100,
    voice = 200,
    general = 500
}
```

#### 4. Troubleshooting

Common issues and solutions:

1. HUD not showing:
   * Check if all dependencies are properly installed
   * Verify resource start order in server.cfg
   * Check browser console for errors
2. Vehicle HUD issues:
   * Ensure LegacyFuel is properly configured
   * Check vehicle class restrictions if applicable
3. Voice indicator not working:
   * Verify pma-voice is running
   * Check voice resource configuration

### Support

For additional support or questions:

1. Check the FAQ
2. Join our Discord server


---

# Agent Instructions: 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:

```
GET https://lualab.gitbook.io/lualab-docs/lualab-scripts/lualab-hud.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
