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

# Setup

### Requirements

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

For network (cross-server) setup:

* A proxy server (Velocity, BungeeCord)
* A MySQL/MariaDB/PostgreSQL database
* A Redis server (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 

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.

{% hint style="info" %}
Due to PLUGIN\_MESSAGE limitations, data can't be synchronized if there are no players online, so if possible always use REDIS
{% endhint %}

### 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 

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


---

# 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://ultimatereports.gitbook.io/ultimatereports-docs/documentation/getting-started/quickstart.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.