# NoPixel HUD

> Many NoPixel HUD packages are paid releases. Ensure you have a legitimate copy and follow the developer's licensing terms before installing.

## Overview

NoPixel-inspired HUDs mimic the layout used on the popular NoPixel roleplay server. They typically include vertical status bars, clean typography, and a dynamic vehicle interface. These HUDs integrate with QBCore stats while delivering a high-end look.

## Common Features

- Vertical vitals stack showing health, armour, hunger, thirst, and stress
- Voice activity indicator that responds to pma-voice or mumble-voip
- Animated vehicle HUD with speed, RPM, gear, cruise control, and seatbelt states
- Weapon wheel or quickslot readouts positioned near the minimap
- Configurable colours, fonts, and opacity to match your server branding

## Installation Outline

1. Upload the HUD resource folder (name varies by vendor) to `resources/[qb]/` or `[standalone]/`.
2. Disable `qb-hud` and any other HUD overlays to prevent conflicts.
3. Add the resource to `server.cfg` **after** voice/chat scripts:

   ```cfg
   ensure qb-core
   ensure pma-voice
   ensure nopixel-hud
   ```

4. Follow the vendor's instructions for license key activation if applicable.
5. Restart the server and verify that the HUD loads with the correct styling.

## Configuration Tips

- **Status Keys**: Map your metadata fields (e.g., `thirst`, `hunger`, `stress`) if you use custom names.
- **Voice Integration**: Set the correct export if you use a non-standard voice resource.
- **Color Scheme**: Modify CSS variables or `config.lua` to align with your brand colours.
- **Vehicle Metrics**: Adjust maximum speed, metric/imperial display, and gear animations from the config file.
- **Performance**: Disable optional animations on low-end servers to reduce client load.

## Customization Ideas

- Replace icons with your own brand pack by editing `html/images/`.
- Move the status stack to the bottom or top corners by adjusting CSS flex properties.
- Enable radar auto-hide by toggling the `Config.HideMinimap` option if included.
- Pair the HUD with a matching notification pack or radio UI for a unified aesthetic.

## Troubleshooting

| Issue | Fix |
|-------|-----|
| Bars show incorrect values | Confirm your server updates the metadata events expected by the HUD (often `QBCore:Player:SetPlayerData`). |
| Voice indicator stuck | Verify your voice script exports `GetPlayerRadioChannel` or the event referenced in the HUD config. |
| HUD overlaps minimap | Adjust CSS offsets or disable the minimap mask setting if you use a custom minimap resource. |
| License error message | Double-check the license key or domain/IP whitelist configured by the vendor. |

## Additional Resources

- Vendor documentation or README file included with the purchase
- Community showcase channels for layout inspiration and custom themes
- [LGF HUD](/resources/hud/lgf-hud) and [TREW HUD](/resources/hud/trew-hud) as alternative design options
