> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roadshop.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Complete setup guide for Road Pause Menu

# Installation

Road Pause Menu replaces the pause menu and the minimap with one interface:
a 2D and 3D world map with search and GPS routes, a minimap players can shape
themselves, your server's name and logo, and a hand-off to the native game
settings.

![Road Pause Menu with the 3D world map of Los Santos](https://mintcdn.com/roadshop/FYbGM5OFPpwwhJH-/images/roadpausemenu/map-3d.webp?fit=max\&auto=format\&n=FYbGM5OFPpwwhJH-\&q=85\&s=267cc02ba10179b8ba043aaa3d5fd7e8)

> [!CAUTION]
>
> **Do not use FileZilla**. It can corrupt or skip hidden files during upload.
> We recommend **WinSCP**.

> [!NOTE]
>
> The download comes from the [cfx.re Portal](https://docs.roadshop.org/license-system.md). No database
> and no SQL import are needed: player preferences are saved on each player's
> own PC.

## 📋 Prerequisites

> [card] Framework
>
> ESX, QBCore, Qbox or no framework (standalone). The included RoadShop
> Bridge detects it automatically.

> [card] Outbound HTTPS
>
> 3D buildings and map images stream from RoadShop's map service. See
> [Map data](https://docs.roadshop.org/roadpausemenu/map-data.md).

## 🚀 Setup Instructions

**1. Extract the resource**

Put the folder into your resources. We recommend a `[road]` folder
alongside our other scripts:

```bash theme={null}
resources/
└── [road]/
    ├── road_pausemenu/
    └── other_scripts/
```

> [!WARNING]
>
> The folder name must stay `road_pausemenu`. Exports, the blip
> integration and the map data address use this name.

**2. Start it after your framework**

```cfg server.cfg theme={null}
# your framework first
ensure road_pausemenu
```

**3. Add your server name and logo**

```lua config.lua theme={null}
Config.Server = {
    Name = 'Road Roleplay',
    Subtitle = 'Los Santos & Blaine County',
    Logo = 'assets/server-logo.svg'
}
```

Replace `public/assets/server-logo.svg` with your own logo, or put an
`.svg`, `.png`, `.webp` or `.jpg` file into `public/assets/` and point
`Logo` at it. Web addresses are not allowed here.

**4. Restart the server**

Restart the server, or run `refresh` and `ensure road_pausemenu` in the
server console.

## 🌐 Language

```lua config.lua theme={null}
Config.Locale = 'en'
```

English (`en`) and German (`de`) are built in. `Config.Locale` is the
language for new players; each player can switch it in **Interface**. The
texts live in `public/locales/en.json` and `public/locales/de.json` and stay
editable after the Asset Escrow upload.

## ✅ Verification

1. The server console shows no `road_pausemenu` errors on start.
2. In game, **Esc** opens the menu with your server name and logo instead of
   the GTA pause menu.
3. **F10** or `/roadmap` opens the map.
4. The map loads the city in **3D** after a short moment, and the minimap
   appears in the bottom left corner.

## 📚 Next Steps

> [card] [Player guide](https://docs.roadshop.org/roadpausemenu/player-guide.md)
>
> Map, search, routes, minimap and interface settings

> [card] [Configuration](https://docs.roadshop.org/roadpausemenu/configuration.md)
>
> Keys, places, territories and branding

> [card] [Map data](https://docs.roadshop.org/roadpausemenu/map-data.md)
>
> How the 3D map streams and what your server stores

> [card] [FAQ](https://docs.roadshop.org/roadpausemenu/faq.md)
>
> Any problems or questions?


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.