Setup

In this page you will learn how to setup UltimateReports for either your paper servers, or your proxied network of paper servers.

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.

Due to PLUGIN_MESSAGE limitations, data can't be synchronized if there are no players online, so if possible always use REDIS

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

Remember to change the server-name in each config, otherwise you will encounter issues.

5. Restart all the servers

• Restart the server that you used to modify the config

• Start all the other servers