# Configuration

> Everything you can change lives in one file — config/config.lua.

Open **`config/config.lua`** in the `nobit_map` folder with any text editor. Every setting is explained inside it as well.

> [!TIP]
> **You cannot break the map with a typo.** If a setting is written wrongly, the resource ignores it, prints one line in the console naming it, and carries on with the built-in default.

After changing anything, restart the resource: `restart nobit_map` in the server console.

***

## Keys

```lua
openKey = 'M',
openKeyEnabled = true,
```

`openKey` opens the fullscreen map. It is only the **starting** key — players can rebind it in FiveM's keybind settings (Settings → Key Bindings → FiveM), and changing it here will not take their choice away.

Set `openKeyEnabled = false` to register no key at all. The map then opens only from the pause menu or with `exports.nobit_map:OpenMap()`.

## What is switched on

```lua
minimapEnabled     = true,
pauseMenuEnabled   = true,
dimension3dEnabled = true,
cayoPericoEnabled  = true,
postalsEnabled     = true,
gameHudColour      = true,
```

| Setting              | What `false` does                                                                                                     |
| -------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `minimapEnabled`     | No minimap when a player joins. You can still show it later with `ShowMinimap`.                                       |
| `pauseMenuEnabled`   | **Esc** opens GTA's own pause menu as usual. The fullscreen map and minimap keep working.                             |
| `dimension3dEnabled` | Removes the 2D / 3D switch everywhere. The 3D city model is never loaded and everyone stays on the flat map.          |
| `cayoPericoEnabled`  | Hides Cayo Perico. Turn it off if your server does not use the island.                                                |
| `postalsEnabled`     | Removes the **Postals** button and postal search from the fullscreen map.                                             |
| `gameHudColour`      | GTA's own menu, waypoint and GPS line keep their stock colours instead of following the player's theme colour.       |

> [!NOTE]
> The game's radar is hidden the whole time this resource runs. With `minimapEnabled = false` your HUD has **no radar at all** until a script shows the minimap.

## Your server in the pause menu

```lua
serverName = 'NOBIT RP',
```

The name in the pause menu header. The logo beside it is `config/logo.svg` — replace it with your own `logo.png`, `.svg`, `.webp` or `.jpg` in the same folder.

## Language and units

```lua
locale = 'en',
units  = 'imperial',
```

`locale` is the name of a file in `config/locales`, without `.json`. See [Translating the map](/docs/3d-map/translation).

`units` is `'imperial'` (ft, mi) or `'metric'` (m, km). It is server-wide; players cannot change it. Imperial is the default because that is what GTA's own HUD uses.

## Blips from other resources

```lua
unlinkedBlips = 'show',
```

Blips from resources that are not [linked to the map](/docs/3d-map/blip-names) are shown in a basic form with `'show'`, or left off the map with `'hide'`. The console lists which blips are not linked, by icon, so you know which resources to link.

## First-run look

```lua
defaults = {
    style           = 'game',
    dimension       = '2d',
    theme           = 'orange',
    postals         = false,
    legendCollapsed = false,

    minimap = {
        dimension = '2d',
        shape     = 'wide',
        size      = 'regular',
        placement = 'bottom-left',
        rotation  = 'heading',
        zoom      = 'normal',
    },
},
```

How the map looks for someone who has **never changed it**.

| Setting             | Options                                                                                              |
| ------------------- | ---------------------------------------------------------------------------------------------------- |
| `style`             | `'game'` (the game's own artwork), `'print'` (pale paper map), `'render'` (satellite-style render)   |
| `dimension`         | Fullscreen map: `'2d'` or `'3d'`                                                                     |
| `theme`             | `orange`, `red`, `pink`, `purple`, `violet`, `blue`, `cyan`, `teal`, `green`, `lime`, `yellow`, `white` |
| `postals`           | Postal codes shown on the fullscreen map from the start                                              |
| `legendCollapsed`   | Legend folded to a strip of icons                                                                    |
| `minimap.dimension` | `'2d'` or `'3d'`                                                                                     |
| `minimap.shape`     | `'wide'` (like GTA's radar), `'square'` or `'circle'`                                                |
| `minimap.size`      | `'small'`, `'regular'` or `'big'`                                                                    |
| `minimap.placement` | `'bottom-left'`, `'bottom-right'`, `'top-left'` or `'top-right'`                                     |
| `minimap.rotation`  | `'heading'` turns with the camera, `'north'` keeps north up                                          |
| `minimap.zoom`      | `'close'`, `'normal'` or `'far'`                                                                     |

> [!NOTE]
> **These are starting points, not rules.** Every one of them belongs to the player afterwards, and the map remembers each player's choice. Changing a value here affects new players only.

If `dimension3dEnabled = false`, any `'3d'` default is started as `'2d'`, with a line in the console.