Getting Started

Getting started

Requirements

Component	Required version
Server	Paper 1.21.11
Java	21
Other plugins	None required

Rivet is built against Paper. Spigot and Bukkit-only servers are not supported targets.

Install Rivet

1. Stop the server.
2. Put the Rivet JAR in the server's plugins folder.
3. Start the server.
4. Check the console for configuration errors.
5. Join as an operator and run /rivet.

Rivet creates plugins/Rivet/ during its first startup.

First setup

The default configuration enables the general survival features and leaves more invasive or specialised systems disabled. Before opening the server to players:

1. Read plugins/Rivet/modules.yml and enable only the large features you want.
2. Restart after changing module switches.
3. Set the server spawn with /setspawn if the spawn module is enabled.
4. Review settings/teleports.yml, especially the warmup and shared cooldown.
5. Review settings/gameplay.yml for crop protection, water replanting, Iron Golem poppies, and faster hoppers.
6. If using Rivet's permission system, enable permissions and configure settings/permissions.yml. Otherwise, use your existing permission plugin.

Reload settings

Run:

/rivet reload

Rivet validates the global file, module switches, and every settings file before applying a reload. If one file is invalid, the current in-memory configuration stays active and the console names the file that failed.

Module enable or disable changes do not take effect during a reload. Restart the server to apply them.

Update Rivet

1. Stop the server.
2. Back up the current JAR and plugins/Rivet/.
3. Replace the JAR.
4. Start the server and read the migration messages in the console.
5. Check newly added settings before changing them.

Rivet adds missing default keys without replacing existing administrator choices. Supported old files and values are migrated before modules start. See Data and upgrades for details.

Build from source

git clone https://github.com/byalex33/Rivet.git
cd Rivet
mvn package

Use JDK 21. The Maven package phase runs the test suite and creates the shaded plugin JAR.

Metrics

Rivet uses bStats for anonymous usage metrics. The standard global opt-out is in:

plugins/bStats/config.yml