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

# Installation Guide

The installation process for STALK Pause Menu has been designed to be quick, clean, and simple to set up on your server.

`stalk_pausemenu` is a standalone custom pause menu resource that replaces the default pause menu behavior with a modern STALK interface. The script includes a live map launcher, settings access, keybind information, Tebex shop links, FAQ, support reports, patch notes, and a quit game option.

The resource does not require any framework and can be configured directly through the `config/config.lua` file.

***

## Step 1 : Resource Installation

Start by dragging the `stalk_pausemenu` folder into your server’s `resources` directory.

You can place it inside a folder such as:

```
resources/[stalk]/stalk_pausemenu
```

or

```
resources/[ui]/stalk_pausemenu
```

Once the folder has been added, open your `server.cfg` file and add the following line:

```
ensure stalk_pausemenu
```

After saving the changes, restart your server.

***

## Step 2 : Main Configuration

All main configuration settings are located inside:

```
stalk_pausemenu/config/config.lua
```

From this file, you can customize the menu behavior, branding, categories, keybinds, FAQ, patch notes, shop products, support system, and optional events.

The script is standalone, which means no ESX, QBCore, or other framework is required.

***

## Step 3 : Basic Menu Settings

The main behavior of the pause menu can be configured at the top of the config file.

```
Config.Debug = falseConfig.CloseWithEscape = trueConfig.BlockDefaultPause = trueConfig.OpenSettingsFrontend = trueConfig.EnableQuitButton = trueConfig.SupportWebhook = ''
```

`Config.CloseWithEscape` allows players to close the menu by pressing Escape again. `Config.BlockDefaultPause` blocks the default GTA V pause menu so the custom STALK pause menu opens instead. `Config.OpenSettingsFrontend` allows the Settings tab to open the native GTA V settings interface, and `Config.EnableQuitButton` controls whether the Quit Game option is displayed in the menu.

If you want support reports to be sent to Discord, you can add your webhook URL inside `Config.SupportWebhook`.

***

## Step 4 : Branding Configuration

You can customize the identity of the menu directly from the `Config.Brand` section.

```
Config.Brand = {    title = 'STALK STUDIO',    subtitle = 'Custom pause menu',    greeting = 'Welcome back',    logo = 'assets/stalk_logo.png'}
```

This section allows you to change the menu title, subtitle, greeting text, and logo.

To replace the logo, add your image inside the `html/assets` folder and update the `logo` path with the correct file name.

***

## Step 5 : Menu Categories

The pause menu categories are configured inside `Config.Categories`.

```
Config.Categories = {    { key = 'maps', label = 'Maps', icon = '🗺️' },    { key = 'settings', label = 'Settings', icon = '⚙️' },    { key = 'keys', label = 'Keybinds', icon = '⌨️' },    { key = 'shop', label = 'Shop', icon = '🛍️' },    { key = 'faq', label = 'FAQ', icon = '❔' },    { key = 'support', label = 'Support', icon = '🛟' },    { key = 'patchnotes', label = 'Patch Notes', icon = '📝' },    { key = 'quit', label = 'Quit Game', icon = '⏻' }}
```

You can rename categories, change icons, or remove entries you do not want to display.

If you disable the quit button with `Config.EnableQuitButton = false`, the quit option will no longer appear for players.

***

## Step 6 : Manual Command & ESC Menu

Players can open the pause menu using the Escape key.

The resource also includes a manual command:

```
/stalkpause
```

This command can be useful for testing the menu or opening it manually if needed.

***

## Step 7 : Keybinds Page

The Keybinds page is fully configurable from `Config.Keys`.

```
Config.Keys = {    { label = 'Interact', key = 'E' },    { label = 'Inventory', key = 'TAB' },    { label = 'Phone', key = 'F1' },    { label = 'Emote Menu', key = 'F3' },    { label = 'Scoreboard', key = 'F6' },    { label = 'Push To Talk', key = 'N' },    { label = 'Hands Up', key = 'X' },    { label = 'Seatbelt / Vehicle', key = 'B' }}
```

You can edit this list to match your server keybinds. Each entry includes a label and the key displayed inside the menu.

***

## Step 8 : FAQ Configuration

The FAQ page can be customized inside `Config.FAQ`.

```
Config.FAQ = {    {        question = 'How do I open this menu?',        answer = 'Press Escape once to open the custom pause menu, then press Escape again to close it.'    }}
```

You can add as many questions and answers as needed to help players understand your server systems, rules, controls, or common issues.

***

## Step 9 : Patch Notes Configuration

The Patch Notes page is controlled by `Config.Patchnotes`.

```
Config.Patchnotes = {    {        title = 'Pause Menu Update',        date = '23/03/2026',        items = {            'Spawn category replaced with a live GTA V map launcher.',            'Shop category added with Tebex redirect buttons.',            'All interface text translated to English.'        }    }}
```

This section is useful for showing recent server updates directly inside the pause menu.

You can create multiple update entries by duplicating the existing structure.

***

## Step 10 : Support System

The resource includes a support report system that allows players to send issues directly from the pause menu.

The support text settings can be edited here:

```
Config.Support = {    minLength = 8,    maxLength = 800,    placeholder = 'Explain your issue, where it happened, and how to reproduce it.',    successText = 'Your report has been sent to the support team. Thank you.',    emptyText = 'Please describe your issue before sending it.'}
```

To receive reports on Discord, add your webhook here:

```
Config.SupportWebhook = 'YOUR_DISCORD_WEBHOOK'
```

If no webhook is configured, the support system will not send reports to Discord.

***

## Step 11 : Map Page Configuration

The Maps tab opens the native GTA V pause map with live blips, markers, and the current world state.

The page content can be customized here:

```
Config.Map = {    title = 'Live GTA V Map',    description = 'Open the real GTA V pause map with live blips, markers, and the current world state.',    image = 'assets/gta_map.jpg'}
```

You can change the title, description, and preview image displayed inside the menu.

***

## Step 12 : Shop / Tebex Configuration

The Shop page displays selected products from your Tebex store and allows players to open them directly.

```
Config.Shop = {    title = 'Stalk Store',    description = 'Discover selected products from the Stalk Tebex store and open them instantly.',    buttonText = 'Open on Tebex',    products = {        {            title = 'VIP Bronze',            description = 'Starter perks for players who want a first premium upgrade.',            price = '€4.99',            tag = 'Starter Pack',            url = 'https://YOUR-TEBEX-STORE.tebex.io/package/bronze'        }    }}
```

Before using the resource publicly, replace all example Tebex URLs with your real store links.

You can add or remove products by editing the `products` list.

***

## Step 13 : Optional Hooks & Data Providers

The resource includes optional hooks that can trigger client events when the menu opens or closes.

```
Config.Hooks = {    onOpen = '',    onClose = ''}
```

You can also configure a custom server event if you want to enrich menu data later.

```
Config.DataProviders = {    serverEvent = '',}
```

These options are optional and can be left empty if you do not need custom integrations.

***

## Important

Before updating the resource or modifying important settings, we strongly recommend creating a full backup of your server and existing resources.

Even though the script is standalone and easy to configure, backups remain essential to avoid issues caused by incorrect configuration, missing assets, or external conflicts.

***

## AI / Documentation Queries

If some information is not directly available on this page, you can dynamically query the documentation using the `ask` parameter.

Example:

```
GET https://docs.stalk.dev/stalk-pausemenu/installation-guide.md?ask=<your-question>
```

You can ask questions such as how to change the logo, how to edit the shop products, how to configure the Discord support webhook, how to disable the quit button, or how to customize the keybinds page.

The system will automatically return a direct answer along with the most relevant documentation sections.