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

# Installation

{% hint style="info" %}
UltimateGuilds requires **Java 21** and a server running **Minecraft 1.20+** (Paper is recommended).
{% endhint %}

* Drop the `UltimateGuilds-Bukkit` jar into the server `plugins` folder and start the server once to generate the configuration.
* By default the plugin stores data in an embedded **H2** database, so it works out of the box with no extra setup.
* To use **MariaDB**, set `database.type` to `MariaDB` and fill in the `database.mariadb` credentials in `config.yml`.
* For **multi-server / proxy networks**, set `enable-proxy-support` to `true` and configure the `database.redis` connection. Redis is only used to synchronise guilds across servers — a single server does not need it.

{% hint style="warning" %}
`PlaceholderAPI` and `LuckPerms` are optional soft dependencies. Install them if you want `%guilds_*%` placeholders or automatic guild-tag suffixes.
{% endhint %}