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

# config.yml

Every setting in `plugins/MarkdownGuide/config.yml`. The file explains each one above it too. Run `/guide reload` after changing anything.

## \[Part 1] - The resource pack

| Setting                              | Default                                           | What it is                                                                 |
| ------------------------------------ | ------------------------------------------------- | -------------------------------------------------------------------------- |
| `resource-pack.serve.public-address` | `PASTE-YOUR-SERVER-ADDRESS-HERE`                  | Your server's IP or domain, without the port. Every real server needs this |
| `resource-pack.serve.port`           | `8085`                                            | The port the pack is offered on; open it on your host                      |
| `resource-pack.serve.enabled`        | `true`                                            | Offer the pack from this server. Leave it on                               |
| `resource-pack.url`                  | empty                                             | A direct link to the pack somewhere else, used instead of the two above    |
| `resource-pack.prompt`               | "This server's guide uses a small resource pack." | What players read when asked about the pack                                |
| `resource-pack.required`             | `false`                                           | `true` disconnects players who say no to the pack                          |
| `resource-pack.hide-warning-button`  | `true`                                            | Hides the small warning button next to the guide window's title            |

## \[Values]

| Setting     | What it is                                   |
| ----------- | -------------------------------------------- |
| `variables` | Your own values, used in pages as `{{name}}` |
| `lists`     | Lists for `{% for %}` on a page              |

See [Pages for each player](/plugins/markdown-guide/writing-pages/for-each-player.md).

## \[Layout]

| Setting              | Default   | What it is                                            |
| -------------------- | --------- | ----------------------------------------------------- |
| `layout.mode`        | `sidebar` | `sidebar`, or `simple` for one column                 |
| `layout.title`       | `Guide`   | The title of every guide window                       |
| `layout.title-icon`  | empty     | A picture in front of the title                       |
| `layout.sidebar.min` | `80`      | The narrowest the page list gets, in pixels           |
| `layout.sidebar.max` | `110`     | The widest the page list gets                         |
| `layout.content.max` | `280`     | The width of the page itself                          |
| `layout.gap`         | `12`      | The room between the two                              |
| `layout.min-height`  | `24`      | Short pages are made this many lines tall; `0` is off |

See [Layout and opening the guide](/plugins/markdown-guide/look-and-layout/layout.md).

## \[Opening]

| Setting                    | Default | What it is                                |
| -------------------------- | ------- | ----------------------------------------- |
| `quick-actions.hotkey`     | `true`  | The guide on the game's Quick Actions key |
| `quick-actions.pause-menu` | `false` | The guide on the pause menu too           |

## \[Advanced]

| Setting                 | Default                           | What it is                                    |
| ----------------------- | --------------------------------- | --------------------------------------------- |
| `font.monospace`        | `false`                           | Pages in a font where every letter is as wide |
| `font.size`             | `10`                              | How tall that font's letters are              |
| `font.advance`          | `0`                               | How wide one letter is; `0` measures it       |
| `web-editor.url`        | `https://markdown.esmp.fun/edit/` | The editor                                    |
| `web-editor.relay-url`  | `https://bin.esmp.fun/`           | Carries your pages to the editor and back     |
| `web-editor.socket-url` | `https://bin.esmp.fun/socket/`    | The live preview and one-click saving         |

The three web editor addresses only change if you [run the editor yourself](/plugins/markdown-guide/reference/run-it-yourself.md).