Getting Started

🚀 Getting started

Rivet runs on Paper 1.21.11 with Java 21. It has no required runtime dependencies.

Install Rivet

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

On first launch, Rivet creates this layout:

plugins/Rivet/
├── config.yml
├── modules.yml
├── settings/
│   ├── afk.yml
│   ├── announcements.yml
│   ├── backpacks.yml
│   ├── breeders.yml
│   ├── chat.yml
│   ├── daily.yml
│   ├── egg-capture.yml
│   ├── environment.yml
│   ├── filter.yml
│   ├── glow.yml
│   ├── graves.yml
│   ├── holograms.yml
│   ├── homes.yml
│   ├── inventory.yml
│   ├── join-leave.yml
│   ├── kits.yml
│   ├── mob-heads.yml
│   ├── near.yml
│   ├── nicknames.yml
│   ├── permissions.yml
│   ├── poses.yml
│   ├── rtp.yml
│   ├── spawn.yml
│   ├── staff.yml
│   ├── statistics.yml
│   ├── tpa.yml
│   ├── trash.yml
│   ├── tree-feller.yml
│   ├── utilities.yml
│   ├── warps.yml
│   └── worlds.yml
└── data/

The three kinds of file

Location	Purpose	Safe to edit?
config.yml	Rivet-wide titles, sounds and particles	Yes
modules.yml	Turns complete features on or off	Yes; restart afterwards
settings/*.yml	Behaviour, limits, formats and messages	Yes
data/*.yml	Player state and generated records	Only while the server is stopped

Caution

Do not hand-edit files in data/ while the server is running. A later save can replace your changes.

Apply configuration changes

Run:

/rivet reload

The reload is all-or-nothing. Rivet validates config.yml, modules.yml and every settings file before replacing the active configuration. If one file contains invalid YAML, the old settings stay active and the console names the problem file.

Changes to module switches are reported but are not started or stopped halfway through a session. Restart the server to apply them.

Build from source

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

The project requires JDK 21. Maven runs the tests and builds the shaded plugin JAR during the package phase.

Update Rivet

1. Stop the server.
2. Back up plugins/Rivet/ and the old JAR.
3. Replace the JAR with the new build.
4. Start the server and read the console once.
5. Run /rivet reload after any manual setting changes.

Rivet migrates older layouts before modules start. It keeps existing values where a new destination already exists. See Data and upgrades for the exact migration rules.

Metrics

Rivet uses bStats for anonymous server and player counts. Server owners can use the standard global opt-out in:

plugins/bStats/config.yml

Next steps

• Choose features in Configuration.
• Set up staff access with Permissions.
• Browse every syntax in the Command reference.