Installation

Download & unzip

Unzip the jg-hud-bundle and open the jg-hud-bundle folder.

Add the resource to your server

Drag the script folder within (jg-hud) into a new folder called [jg] within your server's resources folder.

Install ox_lib

Make sure you have the latest version of ox_lib installed on your server. This script does not use a database, so oxmysql is not required.

Update your server.cfg

Inside of your server.cfg, add a new line after all your other resources have started:

ensure [jg]

Configure the script

There are some basic options to adjust in config/config.lua - mainly integrations, guard rails and essential options to get things up and running. Built-in datasets such as speed limits, GTA V HUD component hiding and train stations live in config/config.data.lua.

Set your voice system in config/config.lua:

Config.Voice = "auto" -- or "pma-voice", "yaca-voice"

Leave this on "auto" to detect your running voice resource. If both are running, YACA takes priority. Set "pma-voice" or "yaca-voice" to use that system explicitly. Start your voice resource before jg-hud, then restart jg-hud after changing this setting.

Nearest postal data is in data/nearest-postal - full credits to BlockBa5her/DevBlocky, whose original repo is on GitHub.

Everything else is customised in-game - see Editing the HUD next.

Keep stream/minimap.gfx and stream/minimap.ytd from the same HUD download. They work together to display minimap icons across game builds. Replacing only the GFX can show the wrong icon or cut it in half. If you use a custom map, check that it doesn't also stream different files with these two names. The HUD does not replace the map tiles in minimap_sea_*.ytd.