Configuration

Everything is in config.lua, which stays open and editable. Players pick their own map style and day / night mode in-game; the keys below set what is offered and the defaults.

General

Key	Default	Description
`Config.Locale`	`'en'`	Panel language, a file name from `locales/`. `en` and `fr` ship.
`Config.Debug`	`false`	Prints diagnostics in the F8 console.
`Config.ServerName`	`''`	Line shown under the area name, top left. Empty hides it.
`Config.ScanInterval`	`10000`	How often the list of places is refreshed, in ms.
`Config.ShowUnnamed`	`false`	Also list blips that have no name, under their category name.
`Config.Colors`	`accent '255 255 255'`, `surface '15 15 18'`	Panel colours until the hz_lib theme loads (`'r g b'`).

Another language: copy locales/en.lua to a new file (for example locales/de.lua), translate the text, and set Config.Locale = 'de'. Missing lines fall back to English.

Zoom & GPS

Key	Default	Description
`Config.ZoomOut`	`1.5`	How far the pause map zooms out. The game stops at `2.73`; lower goes further (`1.0` shows the whole state). `false` keeps the game's limit.
`Config.Gps.Enabled`	`true`	`false` keeps the game's purple route and waypoint.
`Config.Gps.route`	`'246 118 168'`	Route colour (`'r g b'`).
`Config.Gps.light`	`'252 160 196'`	Light shade of the waypoint marker.
`Config.Gps.dark`	`'123 59 84'`	Dark shade of the waypoint marker.

Night map

Key	Default	Description
`Config.Night.Enabled`	`true`	`false` keeps the day map all the time. The Day / night choice disappears, and `stream/night` can be deleted.
`Config.Night.From`	`20`	Game hour the night map starts (0–23).
`Config.Night.To`	`6`	Game hour it ends.
`Config.Night.Default`	`'auto'`	What players get before they choose: `'auto'` (the hours above), `'day'` or `'night'`.

Map styles

Config.Themes = {
    Default = 'atlas',
    Choices = { 'atlas', 'satellite', 'native' },
}

Key	Description
`Default`	Style of players who never picked one.
`Choices`	Styles offered at the bottom of the places panel. A single choice hides the picker.

Without 'satellite' you can delete stream/satellite, without 'native' the stream/native folder. More in Map styles & night map.

Categories

The places panel groups blips into categories, in this order:

Config.Categories = {
    { id = 'services', sprites = {}, match = { 'police_station', 'hospital', 'fire_station' } },
    { id = 'jobs', sprites = { 477, 513 }, match = { 'garbage', 'taxi', 'tow_truck' } },
    { id = 'shops', ... },
    { id = 'vehicles', ... },
    { id = 'leisure', ... },
}

Field	Description
`id`	Category key. Its title comes from the locale (`services` shows as Government).
`sprites`	Blip icon numbers that belong here.
`match`	Parts of the game icon name (full list in `web/data/blips.json`).
`label`	Optional title that replaces the translation.

Blips that match nothing go to Other.

To move one blip by its exact name, use Config.Overrides:

Config.Overrides = {
    ['Mechanic'] = 'vehicles',
}

Key bar

Config.Keys sets the keys shown at the bottom of the full-screen map, with their keyboard and gamepad labels. controls are the game controls behind each action, back the same action in reverse. An action without controls is one the map already does on its own.

Action	Keyboard	Gamepad
Switch tabs	`Q` / `E`	`LB` / `RB`
Set waypoint	`ENTER`	`A`
Browse places	`▲` `▼`	`▲` `▼`
Cycle the spots of a place	`◀` `▶`	`◀` `▶`
Zoom	`PGUP` + `PGDN`	`LT` + `RT`
Show / hide a type	`T`	`X`
Close	`ESC`	`B`

Cayo Perico

Cayo Perico is not in config.lua. To hide the island, open fxmanifest.lua and comment out its line:

    -- 'client/cayo.lua', -- Cayo Perico on the map. Comment this line out to hide the island.