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

# Installation

## Installation

Install SimplyMines on a supported Paper server, then verify the in-game GUI.

### Requirements

* Paper (or a Paper fork) **1.21+**
* Java 21

### Optional integrations

SimplyMines detects these automatically if installed — **none are required**:

{% tabs %}
{% tab title="PlaceholderAPI" %}
Enables all `%simplymines_...%` placeholders.

[Download PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/)
{% endtab %}

{% tab title="ItemsAdder" %}
Enables custom block support in mine compositions.

[Download ItemsAdder](https://www.spigotmc.org/resources/itemsadder.73355/)
{% endtab %}

{% tab title="Nexo" %}
Enables custom block support in mine compositions.

[Download Nexo](https://nexomc.com/)
{% endtab %}

{% tab title="CraftEngine" %}
Enables custom block support in mine compositions.

[Download CraftEngine](https://modrinth.com/plugin/craftengine)
{% endtab %}
{% endtabs %}

***

### Install the plugin

1. Drop the `SimplyMines-<version>.jar` into your server's `plugins/` folder.
2. Start (or restart) the server. SimplyMines will generate its default `config.yml` under `plugins/SimplyMines/`.
3. *(Optional)* Install any of the soft dependencies above **before** starting the server so SimplyMines detects them on load.
4. Give yourself the `simplymines.admin` permission (or set it in your permissions plugin) so you can open the GUI with `/sm`.

{% hint style="warning" %}
Texture-manager plugins (ItemsAdder / Nexo / CraftEngine) are only detected once, on `onEnable`.\
If you install one **after** SimplyMines has already started, a plain `/reload` isn't enough — fully restart the server.
{% endhint %}

***

### Verify the installation

Run `/sm` in-game. If you have `simplymines.admin`, the Mine Browser GUI should open — that confirms the plugin loaded correctly.

{% hint style="success" %}
Ready to build your first mine? Continue to [Quick Start](/simplymines-docs/introduction/quick-start.md).
{% endhint %}


---

# 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, and the optional `goal` query parameter:

```
GET https://simplymines.gitbook.io/simplymines-docs/introduction/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.