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

# Setup

### In need of a Player Reports plugin?

Check my other plugin:

<https://modrinth.com/plugin/ultimate-reports>

### Requirements

{% hint style="info" %}
Those requirements are valid for newer versions of the plugin. you can find builds for older server versions (like 1.16.5 and/or spigot) on modrinth.
{% endhint %}

* A paper-based Minecraft server (1.19.4 or higher)
* Java 21 or higher

For network (cross-server) setup:

* A proxy server (Velocity, BungeeCord)
* A MySQL database
* A Redis database (for best performances)

## Single-server installation:

### 1. Install the jar

Place the plugin's jar in the plugins directory of your Paper server.

#### 2. Restart the server

* Start then stop the server
* Edit the configuration, messages, gui to your liking
* Optionally, configure a remote database (for best performances)

#### 3. Start the server&#x20;

Start the server again and enjoy the plugin!

## Multi-server installation:

### 1. Install the jar

* Place the plugin's jar in the plugins directory of each Paper server.
* You don't need to install the plugin into the proxy

### 2. Restart the server and configure

* Start one server and configure the plugin configuration files

### 3. Configure the plugin to use cross-server

* Open the config and set the database type to either: **MySQL, MariaDB (preferred if possible), PostgreSQL**
* Configure the database credentials
* Enable cross-server mode
* Optionally, for best performance and to avoid the limitations of PLUGIN\_MESSAGE, set the broker tipe to REDIS and configure the credentials
* change the server name to your proxied server name (the one in the proxy's config). Case sensitive.

### 4. copy and paste the updated config in all the other server

{% hint style="warning" %}
Remember to change the server-name in each config, otherwise you will encounter issues.
{% endhint %}

### 5. Restart all the servers&#x20;

* Restart the server that  you used to modify the config
* Start all the other servers