> For the complete documentation index, see [llms.txt](https://nobit.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nobit.gitbook.io/docs/setting-up/configuration.md).

# Configuration

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

Open **`config.lua`** in the `nobit_map` folder with any text editor. It is the only file you are meant to edit, and every setting is explained inside it as well.

{% hint style="success" %}
**You cannot break the map with a typo.** If a setting is written wrongly, the resource ignores it, prints one line in the server console telling you which one, and carries on with the built-in default.
{% endhint %}

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

***

## The settings

### Opening key

```lua
openKey = 'M',
```

The key that opens the fullscreen map (not pause menu). This is only the **starting** key — players can rebind it in FiveM's own keybind settings (Pause menu → Settings → Key Bindings → FiveM), and if they do, changing this will not take their choice away.

### Inspect gesture

```lua
inspectEnabled = true,
inspectKey = 'LMENU',
```

Holding this key pans and zooms the **minimap where it sits**, without opening the big map. It is the only gesture that lets the player keep driving while they use it. `LMENU` means **Left Alt**.

Set `inspectEnabled = false` if you would rather the minimap were never interactive.

### The minimap

```lua
minimapEnabled = true,
```

Whether the minimap is on screen when a player joins.

{% hint style="info" %}
Setting this to `false` leaves your HUD with **no radar at all** — the game's own radar is hidden the whole time this resource runs, whatever this is set to. You can toggle it on/off with export later.
{% endhint %}

### Turning 3D off

```lua
dimension3dEnabled = true,
```

Whether the 3D map is offered at all. Turning it off removes the 2D/3D button from every surface, and the 3D city model is then **never loaded by anyone**. Set it to `false` if you want every player on the flat map and nothing else.

It is reversible: a player who had already chosen 3D just loads flat, and turning it back on hands them their 3D map back.

{% hint style="warning" %}
Reversible for a while, not forever. The next time that player changes any setting themselves — an accent, a minimap tweak — the flat choice is saved over their old one. Off for a week is fine; off for a month is effectively permanent.
{% endhint %}

### Units

```lua
units = 'imperial',
```

Which units the map writes distances in. `'imperial'` gives feet and miles, `'metric'` gives metres and kilometres. Anything else is refused with a line in the console and imperial is used.

Today this reaches the waypoint route's **Remaining** readout, which is the only distance the map writes out.

This one is server-wide and players cannot change it — unlike the style, colour and 2D/3D settings below, which are theirs. A server measures in one unit for everyone, the same way it runs in one language.

{% hint style="info" %}
Imperial is the default because it is what GTA itself uses, so the map agrees with the game's own HUD out of the box. Set `'metric'` and it stops agreeing — which is usually what a metric community wants.
{% endhint %}

### First-run look

```lua
defaults = {
    style     = 'game',
    dimension = '2d',
    accent    = nil,
},
```

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 photo)                                                                                               |
| `dimension` | `'2d'` or `'3d'`                                                                                                                                                                          |
| `accent`    | `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose` — or `nil` for the built-in indigo |

{% hint style="info" %}
**These are starting points, not rules.** Style, 2D/3D and accent belong to the player, and the map remembers each player's choice. Changing a value here affects new players only — it will never reach back and overwrite someone who has already picked something.
{% endhint %}

Set any field to `nil` to use the built-in default.