> For the complete documentation index, see [llms.txt](https://fantasy-scripts.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://fantasy-scripts.gitbook.io/docs/pause-menu-or-custom-map-+-settings/hiding-your-hud.md).

# Hiding Your HUD

Most servers run a HUD with health, hunger and a speedometer. It looks untidy on top of the map or the settings screen, so fs-ui can ask it to step aside and bring it back afterwards.

This does nothing until you fill it in.

```lua
Config.Hud = {
    onPauseMenu = true,
    onMenu = true,

    resource = 'codem-supreme-hud',
    hide = 'HideHud',
    show = 'ShowHud',
    isHidden = 'IsHudHidden',

    hideEvent = '',
    showEvent = '',
}
```

| Setting       | What it is                                                     |
| ------------- | -------------------------------------------------------------- |
| `onPauseMenu` | Hide the HUD while the pause menu and the map are open         |
| `onMenu`      | Hide it while fs-ui's quick menu and settings are open         |
| `resource`    | Your HUD's folder name. Leave empty and fs-ui touches nothing. |
| `hide`        | Your HUD's export that hides it                                |
| `show`        | Your HUD's export that shows it again                          |
| `isHidden`    | Your HUD's export that answers whether it is already hidden    |
| `hideEvent`   | A client event that hides it, if your HUD uses events          |
| `showEvent`   | A client event that shows it again                             |

### Exports or events

Use whichever your HUD offers. Filling in both is fine; fs-ui will use both. The names come from your HUD's own documentation.

With exports:

```lua
resource = 'my-hud',
hide = 'HideHud',
show = 'ShowHud',
```

With events:

```lua
resource  = 'my-hud',
hideEvent = 'my-hud:client:hide',
showEvent = 'my-hud:client:show',
```

### Players who hid their own HUD

Fill in `isHidden` if your HUD has it. Before hiding anything, fs-ui asks whether the HUD is already hidden — so a player who turned their HUD off themselves keeps it off, instead of having it switched back on for them.

fs-ui only ever brings back a HUD it hid itself.

### If something is wrong

A HUD that is not running, an export that does not exist, a name spelled wrong: none of these break fs-ui. The request is tried and quietly dropped.

Your players' HUD also comes back if fs-ui is stopped while a menu is open.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://fantasy-scripts.gitbook.io/docs/pause-menu-or-custom-map-+-settings/hiding-your-hud.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.