Purpose
configs/hud.jsonc decides which of the map’s on-screen panels are shown. Each is independent, and
turning one off removes it entirely rather than hiding it behind a setting.
The legend and the tabs are always present and are not configurable here. What this file sets is the
starting point: a view may turn any of these panels off, and the
legend, the crosshair and the tab bar with them, for the map it draws.
Options
Embedded pages
A page another resource registers can host its own interface instead of content the map draws. Such
a page is loaded inside the map’s interface, so its address is checked: the NUI origin of a resource
on this server (
cfx-nui-<resource>) is always allowed, and anything else has to have its host
listed here. Adding a host you do not control lets that host decide what a player sees inside the
map, so treat this as a security setting rather than a convenience. See
Pages.
What each panel contains
The player card shows the character name reported by your framework, falling back to the FiveM account name when the framework has none, and the player’s server id. The portrait is generated from the character in game. Another resource can replace any of the three: see Exports. The scale bar uses the unit set in the player’s own game settings, so a player using imperial units sees miles and a player using metric sees kilometres. There is no server-side setting for this. The location readout shows the street and the area the camera is over, not the ones the player is standing in. It updates as the camera moves and goes blank over water and open country, where the game has no street name to report.Example
A minimal interface with only the legend and the map itself:Applying changes
Safety
Each key acceptstrue or false. Any other value is used as written and produces behaviour that
is not one of the two. Use the words, unquoted, exactly as shown above.
Turning off profile also stops the character portrait being generated, which removes a small
amount of work each time the map opens. The other two panels cost little either way; turn them off
for the look, not for performance.
Related
- Configuration
- Exports: replacing the player card’s contents
- How players use the map