# TREW HUD

> TREW HUD is one of the earliest fully modular HUD packages adopted by QBCore servers. It offers extensive configuration options and is compatible with multiple frameworks.

## Overview

Originally released for ESX, TREW HUD has community-maintained forks for QBCore that expose similar functionality: a modular HUD, voice indicators, radial menus, and vehicle dashboards. It is ideal for servers that want a polished UI but still value open-source flexibility.

## Highlighted Modules

- **Player Stats**: Health, armour, hunger, thirst, stress, and stamina bars
- **Vehicle Dashboard**: Speedometer, fuel, engine health, seatbelt, cruise control, and gear display
- **Compass & Street Info**: Direction and street names displayed at the top of the screen
- **Voice Integration**: Works with pma-voice, saltychat, or mumble-voip through configuration toggles
- **Radial Menu**: Optional interaction wheel for emotes, doors, and quick actions

## Installation Steps

1. Download a QBCore-compatible fork of TREW HUD (often named `trew_hud_ui` or `trew-hud-qb`).
2. Place the folder into `resources/[standalone]/` or `[qb]/` depending on the instructions.
3. Disable conflicting HUD packages (`qb-hud`, `legacy_hud`, etc.).
4. Add the resource to `server.cfg`:

   ```cfg
   ensure qb-core
   ensure trew_hud_ui
   ```

5. Import any SQL provided if the fork stores player preferences.
6. Restart the server and validate that the HUD loads with no console errors.

## Configuration Notes

- `config.lua` contains toggles for each widget. Disable modules you do not need to reduce clutter.
- The script exposes language files—edit them to localize UI labels.
- Adjust the `Config.Metric` option to switch between MPH and KPH.
- Update radial menu commands to match your server's emote or vehicle scripts.
- If you use a custom stress system, point the HUD to the correct metadata key.

## Performance Considerations

- TREW HUD relies on NUI updates; ensure clients have hardware acceleration enabled in FiveM for smooth animations.
- Lower the refresh interval (`Config.UpdateInterval`) if you experience stutter on lower-end PCs.
- Disable unused modules such as the radial menu when you only want the HUD overlay.

## Troubleshooting

| Issue | Solution |
|-------|----------|
| HUD overlapping other UI | Confirm no other HUD resource is running and adjust anchor positions in the CSS files. |
| Voice indicator not updating | Double-check the voice integration configuration and ensure the appropriate exports are called. |
| Speedometer stuck at 0 | Verify that `GetVehiclePedIsIn` is returning a valid vehicle and that you installed the required client script dependencies. |
| Compass jitter | Increase the smoothing value in the configuration or lower the update interval. |

## Helpful Links

- GitHub forks maintained by the community (search for `trew_hud_ui qbcore`)
- Discord support servers for the fork you downloaded (usually linked in the README)
- [Pure HUD](/resources/hud/pure-hud) and [V-HUD](/resources/hud/v-hud) if you need lighter alternatives
