> 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/installation.md).

# Installation

Drop the `fs-ui` folder into your resources, keeping the folder name, and add both of these lines to `server.cfg`:

```cfg
ensure fs-ui
add_ace resource.fs-ui command.restart allow
```

Start the server. Press `ESC` in game and the quick menu opens. That is the whole installation.

### The second line

It is only used when you change the map picture (`Config.Map`). fs-ui puts the map files you asked for into place and restarts itself once, so the new map is ready in that same server restart.

Without the line nothing breaks: your new map simply waits for the following server restart. Either way, players see it the next time they join.

### Changing things afterwards

Everything you can change is in `config.lua`. The wording your players read is in `locales/<code>.lua` — fifteen languages, chosen with `Config.Locale`.

After editing either, restart the resource:

```
restart fs-ui
```

Changing the map picture is the one exception: that needs a server restart, as above.

### Before you go live

* Put your server name in `Config.Brand`.
* Replace the two example pages in `Config.Legal` with your own rules and privacy text.
* Go through `Config.Keybinds` and list the commands your server actually uses. The defaults are only examples.
* If you run your own HUD, fill in `Config.Hud` so it gets out of the way while the map or the menus are on screen. See **Hiding your HUD**.


---

# 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/installation.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.
