> For the complete documentation index, see [llms.txt](https://docs.menanak47.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.menanak47.com/multi-framework/ak47_hud.md).

# ak47\_hud

{% embed url="<https://youtu.be/RTgw8OED7wM>" %}

### 🔥 Key Features

Designed to improve roleplay immersion and give players total control over their interface:

#### 🎨 Advanced Customization & Community Hub

* Drag-and-Drop Editor: Fully reposition, scale, and adjust the opacity of any HUD element on your screen with a helpful grid overlay.
* Granular Controls: Change individual colors and shapes through an intuitive React-based settings menu.
* Community Presets: Access the built-in Community Hub to browse, vote on, preview, and instantly import custom HUD layouts created by other players.
* Bulk Toggles: Quickly enable or disable entire categories of the UI (e.g., hiding all vehicle elements or all survival stats).

#### 💬 Comprehensive Roleplay Chat

* Advanced Features: Includes group channels, an emoji picker, and a right-click context menu for quick actions (DM, transfer group ownership, kick, report).
* 3D Roleplay Bubbles: Immersive `/me` and `/do` actions displayed natively over player character models in the 3D world.
* Command Suggestions: Dynamic auto-complete and suggestions for standard and custom commands to help new players.

#### 🚗 Dynamic Vehicle Mechanics

* Adaptive Speedometers: Specialized SVG gauges that change automatically depending on the vehicle type (cars, helicopters, boats, cycles, and emergency vehicles).
* Police Radar: Built-in functional radar with front/rear scanning, patrol limits, and target speed locking.
* Seatbelt & Nitro Logic: Integrated seatbelt system featuring physics-based crash ejections, plus built-in nitrous syncing for exhaust flames.

#### 📊 Player Status & Information

* Survival Stats: Track health, armor, hunger, thirst, and dynamic stress that induces sickness visual effects when too high.
* Economy Overview: Sleek floating display for cash, bank, society funds, and current job info.
* Extra Utilities: Animated killfeed, customizable crosshairs with ammo tracking, a dynamic bar compass, and a location box featuring postal codes.

#### 🛠️ Technical Excellence

* Multi-Framework: Seamlessly works with ESX, QB, and QBX out of the box.
* Optimized Rendering: Uses React & Redux state persistence for a buttery smooth UI that remembers player layouts across sessions without hammering the server.
* Discord Logging: Built-in webhook support to keep track of chat history and system events.

### 💻 Framework:

* ESX, QB, QBX

### ⚙️ Dependencies:

* ak47\_lib: <https://github.com/MenanAk47/ak47_lib/releases/latest>

### ⚙️ How To Install:

* Download `ak47_hud` from your cfx portal.
* Add the script in your resources folder.
* Add this resource at the bottom of your server.cfg, below your framework files.
* Ensure you have all dependencies installed and started first.
* (Optional) Follow the `must read.txt` instructions to load chat-suggestions properly if utilizing the chat module.
* Restart the server.

### 🔗 Links & Support:

* 📖 Documentation: <https://docs.menanak47.com/multi-framework/ak47_hud>
* 🛒 Buy Now (Tebex): <https://menanak47.tebex.io/>
* 💬 Discord Support: <https://discord.gg/MenanAk47>

### 📝 Note:

* We don't support custom frameworks. Make sure you are using official framework updates.
* Renaming the script is not allowed. It may break the functionalities.
* Don't upload the script with FileZilla, Use Winscp if you are using FTP for file uploading.
