# Pure HUD

> Pure HUD is a lightweight alternative to complex HUD packages. It keeps essential information visible while leaving plenty of screen space for cinematic gameplay.

## Overview

Pure HUD targets servers that prefer a clean layout with simple animations. It generally ships as an open-source resource, making it easy to tweak fonts, colours, and positions without proprietary tooling.

## Key Characteristics

- Horizontal status bars for health, armour, hunger, thirst, and stress
- Optional circular minimap mask and seatbelt indicator
- Toggleable compass, street name, and time display
- Performance-friendly code with minimal client-side loops
- Straightforward CSS and JS files for quick design adjustments

## Installation Steps

1. Download the Pure HUD repository and extract it to `resources/[qb]/pure-hud`.
2. Disable `qb-hud` in `server.cfg` to avoid duplicate overlays.
3. Add `ensure pure-hud` below your core resources:

   ```cfg
   ensure qb-core
   ensure pure-hud
   ```

4. Restart the server and confirm that the HUD loads without errors.

## Configuration

Most releases expose their settings through `config.lua` and CSS variables:

- `Config.Display` toggles each widget (compass, clock, minimap outline, etc.).
- `Config.Thresholds` controls colour changes (e.g., low health turning red).
- `Config.UseStress` enables/disables the stress bar for servers that omit stress mechanics.
- `Config.HideInVehicle` hides the basic HUD when the vehicle overlay is active.
- `Config.RefreshRate` defines how often stats update; reduce the rate if you notice performance issues.

## Customization Tips

- Modify `html/css/style.css` to change fonts, corner radius, or spacing.
- Use gradient backgrounds for bars to add depth without cluttering the UI.
- Combine the HUD with minimalist notification systems to maintain the same aesthetic.
- Add server branding by inserting a small logo near the minimap or compass.

## Troubleshooting

| Issue | Resolution |
|-------|------------|
| Bars freeze when entering/exiting vehicles | Restart the resource and check for conflicts with other HUD scripts that alter the minimap state. |
| Compass points the wrong direction | Ensure `SetCompassHeading` is called with the correct `GetEntityHeading(PlayerPedId())` value in the client script. |
| HUD visible in cinematic camera | Enable the `hideHud` option or register the cinematic events provided by the resource. |
| Hunger/stress bars hidden | Toggle the related flags in `config.lua` and confirm your status script updates those values. |

## Additional Resources

- Community forks of Pure HUD on GitHub for inspiration
- QBCore Discord channels where creators share custom themes
- [V-HUD](/resources/hud/v-hud) for a modular alternative if you need more widgets
