Installation
Dependencies
| Dependency | Required | Why |
|---|---|---|
| Framework (ESX / QBCore / QBox / ox_core / vRP) | No | Auto-detected; also runs standalone |
| hz_lib | Yes | Free. The menu loads its UI kit, fonts and theme colours from it, and its settings appear in /hzpanel |
| HZ-Loading | No | Optional — shares one keybinds source if present |
ox_lib | No | Not used; compatible if you run it |
| Database | No | None. Player settings live in client KVP |
hz_lib is the one required resource. Nothing stops HZ-PauseMenu from starting without it, but the menu then opens unstyled, because its UI kit, fonts and theme colours are served by hz_lib, and /hzpanel has no Pause Menu section. Your framework, on the other hand, is detected on its own.
Steps
- Drop the
hz_pausemenufolder into yourresourcesdirectory. - Ensure hz_lib first, so the UI kit and the theme are there at first paint:
ensure hz_lib
ensure hz_pausemenu
- Reconnect.
npm install.
What you should see
Pressing Escape now opens HZ-PauseMenu instead of the native GTA V menu. The default configuration already works on any framework: profile, map, settings and a Discord button, in English.
The native GTA V Settings screen is still reachable from the Settings → GTA V Settings card — and it is recoloured to your accent.
Confirming it works
- Press Escape — the HZ-PauseMenu NUI should open (not the stock Rockstar menu).
- Open the Profile tab — your identity, vitals, licenses and wallet should be filled from your framework.
If the profile shows
-- for a field, your framework simply doesn't expose it (base ESX has no nationality column, for example). See Config.DefaultNationality and the framework notes in Configuration.