Configuration · JM Modifications

All configuration lives in config.lua, which is the only file you need to edit for day-to-day customisation.

Core Settings#

Option	Default	Description
`Config.Enabled`	`true`	Master toggle. Set to `false` to disable the HUD entirely on startup.

Update Rates#

Option	Default	Description
`Config.LocationUpdateMs`	`250`	How often (ms) the street name, zone, heading, and time are refreshed.
`Config.PostalUpdateMs`	`800`	How often (ms) the nearest postal is recalculated. Keep this higher on large postal datasets.

Visibility#

Option	Default	Description
`Config.HideWhenPauseMenu`	`true`	Hides the HUD while the pause menu is open.
`Config.HideWhenHudHidden`	`true`	Hides the HUD when the player's radar or HUD is hidden (e.g. cinematic mode).

Display Toggles#

Each element of the HUD can be turned on or off independently.

Option	Default	Description
`Config.ShowPostal`	`true`	Shows the nearest postal code.
`Config.ShowTime`	`true`	Shows the in-game clock.
`Config.ShowCounty`	`true`	Shows the county name (Los Santos County or Blaine County).
`Config.ShowArea`	`true`	Shows the current zone label.
`Config.ShowDirection`	`true`	Shows the 8-way compass heading.
`Config.ShowRoad`	`true`	Shows the current street and cross street.

Formatting#

Option	Default	Description
`Config.TimeFormat24h`	`false`	`true` for 24-hour clock; `false` for 12-hour with AM/PM.
`Config.PostalCompact`	`true`	`true` shows just the code (e.g. `2012`); `false` prefixes it with `Postal:` .
`Config.RoadSeparator`	`" / "`	String placed between the street name and cross street.

Screen Placement#

Config.Position sets the CSS left and bottom values used when Config.AnchorToMinimap is disabled:

Config.Position = {  left   = "1.8vw",  bottom = "2.8vh",}

When Config.AnchorToMinimap is true the resource calculates the minimap's position at runtime and places the HUD just above it. Use the margin options to fine-tune the gap:

Option	Default	Description
`Config.AnchorToMinimap`	`true`	Automatically positions the HUD above the minimap.
`Config.MinimapMarginX`	`0.005`	Extra horizontal offset (normalised screen units, ~0.5 vw).
`Config.MinimapMarginY`	`0.015`	Extra vertical offset above the minimap (~1.5 vh).

Postal Data#

Option	Default	Description
`Config.PostalsFile`	`'data/postals.json'`	Path to the postal data file relative to the resource root.
`Config.PostalGridSize`	`250.0`	Spatial grid cell size in game units. Larger values mean fewer, slower buckets.
`Config.PostalSearchRings`	`2`	Number of neighbouring grid cells scanned when finding the nearest postal.

Tip

On very large postal lists, increasing Config.PostalGridSize reduces memory usage but may slow per-bucket lookups. Increasing Config.PostalSearchRings improves accuracy near cell boundaries at a small CPU cost.

Near System#

The Near system displays a Near <Place> label when the player is within a set radius of a named location. Configure it under Config.Near:

Option	Default	Description
`Config.Near.Enabled`	`true`	Toggles the Near system on or off.
`Config.Near.Radius`	`150.0`	Detection radius in game units.

Config.Near.Locations is the list of named places. Each entry requires a label, x, and y:

Config.Near.Locations = {    { label = "Legion Square",  x = 215.76,  y = -915.73, z = 30.69 },    { label = "Paleto Bay",     x = -441.23, y = 6015.78, z = 31.72 },    -- add more entries here}

The resource ships with twenty default locations covering major landmarks across both Los Santos and Blaine County. Add, remove, or rename entries freely.

County Mapping#

The HUD determines whether a player is in Los Santos County or Blaine County by checking the game's internal zone short code against Config.Counties.BlaineZones. Any zone not in that list is treated as Los Santos County.

Option	Default	Description
`Config.Counties.LosSantosName`	`"Los Santos County"`	Display name for Los Santos County.
`Config.Counties.BlaineName`	`"Blaine County"`	Display name for Blaine County.
`Config.Counties.BlaineZones`	(list of zone codes)	Zone short codes classified as Blaine County.

Edit Config.Counties.BlaineZones if you use a custom map or if certain zones are misclassified on your server.

Styling#

Config.Style controls the visual appearance of the HUD panel. All values are passed directly to the HTML overlay as CSS variables.

Option	Default	Description
`fontSize`	`"0.95rem"`	Text size.
`lineGap`	`"0.18rem"`	Vertical gap between lines.
`bg`	`"rgba(0,0,0,0.35)"`	Background colour and opacity.
`border`	`"rgba(255,255,255,0.10)"`	Border colour.
`padX`	`"0.65rem"`	Horizontal padding.
`padY`	`"0.45rem"`	Vertical padding.
`radius`	`"0.65rem"`	Corner radius.

Note

Values in Config.Style override the defaults in html/style.css. You can also edit html/style.css and html/index.html directly for deeper visual customisation — these files are not encrypted.

HUD Display Mode#

Config.HUDDisplayMode sets the initial display mode when the resource starts. Valid values are "default", "minimal", and "hidden". This can also be changed at runtime with the /changeHUD command.