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

# pause menu

DialogMaster adds a custom button to the client's **ESC pause screen** and optionally to the **G quick-actions bar**, giving players instant access to the server menu without any command.

***

## How It Works

This is implemented at the bootstrap level (before the plugin fully loads) using Paper's dialog registry API. The button is registered as a named dialog and then tagged to appear in the appropriate client screens.

***

## Configuration

All options live under `pause-menu:` in `config.yml`:

```yaml
pause-menu:
  enabled: true
  # Text shown on the button in the ESC screen and quick-actions bar
  button-name: "Donut SMP"
  # Also add the button to the G quick-actions bar
  quick-actions: true
```

| Field           | Default       | Description                                       |
| --------------- | ------------- | ------------------------------------------------- |
| `enabled`       | `true`        | Toggles the feature entirely                      |
| `button-name`   | `"Donut SMP"` | Label on the button                               |
| `quick-actions` | `true`        | Whether to also appear in the G quick-actions bar |

The button opens whichever menu is set as `general.main-menu-target` in `config.yml` (default: `main-menu`).

{% hint style="info" %}
Changes to `pause-menu` settings require a full server restart — these are registered at bootstrap time before the plugin loads, so `/ydm reload` is not sufficient.
{% endhint %}

***

## Where the Button Appears

* **ESC / Pause screen** — always shown when `enabled: true`, as an addition to the vanilla pause buttons.
* **G quick-actions bar** — shown when both `enabled: true` and `quick-actions: true`. This is the bar players open by pressing G in-game (requires a Paper build that supports `QUICK_ACTIONS` dialog tag).

***

## Dialog Key

The registered dialog key is `ydm:pause_button`. You can reference it externally if needed:

```java
DialogMasterBootstrapper.PAUSE_DIALOG // Key.key("ydm", "pause_button")
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://yowsef-development.gitbook.io/yowsef-development-docs/features/pause-menu.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.