Installation

Installing Roster is incredibly simple. It requires no core plugins and works completely standalone.

Requirements

Before installing, ensure your server meets the following requirements:

• Java Version: 21 or higher
• Server Software: Paper 1.21.1+ (or a high-performance fork like Purpur)

Optional integrations:

• LuckPerms (Recommended for robust group management)
• PlaceholderAPI (Recommended for dynamic sidebar variables)

Step-by-Step Guide

1. Download the latest Roster-x.x.jar from the official Modrinth or Spigot page.
2. Place the JAR file into your server’s plugins/ directory.
3. Completely restart your server.
4. Roster will automatically generate its configuration files in plugins/Roster/.
5. Customize the files to your liking and use /roster reload to apply the changes without restarting.

[!WARNING] Roster utilizes native Minecraft scoreboards for Nametags and Sidebars. If you are running another plugin that heavily modifies scoreboards (like an old TAB plugin), you may experience conflicts. Make sure to remove conflicting plugins.