Installation
Dependencies
| Dependency | Required | Why |
|---|---|---|
| HZ-Bridge | Yes | Admin panel, role permissions, appearance cascade |
| Framework (ESX / QBCore / QBox) | No | HZ-Loading is standalone |
HZ-Bridge is a hard dependency declared in the manifest. If it is missing, HZ-Loading refuses to start rather than booting into a broken state.
Steps
- Drop the
HZ-Loadingfolder into yourresourcesdirectory. - In your
server.cfg, make sure HZ-Bridge starts first:
ensure HZ-Bridge
ensure HZ-Loading
- Restart the server (a loading screen resource cannot be hot-started meaningfully — it only runs while a player connects).
- Reconnect.
npm install.
What you should see
A finished English loading screen: background images, a music track, a real progress bar, a live player count, and example Updates / Rules / tips content in your language.
That default is deliberately shippable. You can run with it as-is, then open the Loading Creator to make it yours.
Confirming it works
The loading screen is, by nature, hard to inspect — it is gone by the time you can type a command. Two reliable checks:
- Look at the server console on boot. HZ-Loading prints its discovered assets, e.g.
[HZ-Loading] assets : 3 audio, 7 images (manifest 3/7 + scan 3/7).
- Run
/hzloading:diagonce in game (admin). It reports the effective configuration and recent session boot times.
"Your Server" and a
0 / – player count means the boot payload never arrived — not that your configuration is wrong. That is a delivery problem (HZ-Bridge not started, or started after HZ-Loading), not a settings problem. Check your server.cfg order first.Permissions
Access to the panel and the right to publish are managed by HZ-Bridge roles. Publishing the loading screen requires the config capability on HZ-Loading, which is separate from general panel access — so you can let a moderator edit the loading screen without making them a global administrator. See Commands & permissions.
