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

# Install it

Drop the plugin in, tell it your server's address so players can download the guide's look, and open it.

## Step 1 - Put the plugin on your server

Drop the MarkdownGuide jar into your server's `plugins/` folder and restart.

The first start makes a folder with everything in it:

```
plugins/MarkdownGuide/
  config.yml        the settings
  style.css         how pages look
  sidebar.md        the list of pages on the left, if you want to pick it yourself
  pages/            your pages, one .md file each, with two examples to start from
  images/           pictures of your own, as PNG files
```

## Step 2 - Let players download the guide's look

Every guide page is drawn with a small resource pack. The plugin makes it and offers it to players from a little download address on your server. That address needs your server's IP or domain.

Open `plugins/MarkdownGuide/config.yml`. The first part is the one that matters:

```yaml
resource-pack:
  serve:
    public-address: "PASTE-YOUR-SERVER-ADDRESS-HERE"
    port: 8085
```

1. Put your server's address where it says `PASTE-YOUR-SERVER-ADDRESS-HERE`, the same one players type to join, without the port. For example `play.myserver.net`.
2. Make sure port `8085` is open on your host, the way the game's own port is. Your host's panel may call it a port or an allocation.
3. In game, run `/guide reload`.

{% hint style="info" %}
**Can't open a port?** Upload `plugins/MarkdownGuide/markdownguide-pack.zip` to any website that gives a direct download link, and put that link in `resource-pack.url`. Upload it again whenever you add pictures or item icons.
{% endhint %}

{% hint style="success" %}
**Only testing on your own computer?** Skip this step. Without an address the pack is offered at `127.0.0.1`, which works when the game runs on the same computer as the server.
{% endhint %}

## Step 3 - Open the guide

In game, run:

```
/guide
```

The first time, the game asks whether to download the server's resource pack. Say yes, and the guide opens on its first page.

<figure><img src="https://1037515809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F37kaU8TF94yOlMmCwXdl%2Fuploads%2Fgit-blob-63716eccbc8ab145bfdd7972a1adba0ec559c727%2Fguide-welcome.png?alt=media" alt="The guide&#x27;s first page"><figcaption><p>The first page, with every page listed on the left.</p></figcaption></figure>

Typing `/guide` and a space suggests your pages, and to admins the commands too.

<figure><img src="https://1037515809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F37kaU8TF94yOlMmCwXdl%2Fuploads%2Fgit-blob-fa34faa4709142fd58709e6753d950cbf868799d%2Fchat-tab-completion.png?alt=media" alt="Suggestions after typing /guide in chat"><figcaption><p>Press Tab to finish a page's name.</p></figcaption></figure>

Next: [write your first page](/plugins/markdown-guide/getting-started/your-first-page.md).