Installation

Requirements

Requirement	Detail
Server software	Paper (RallyPoint uses the Paper API directly)
Minecraft	1.20 or newer
API version	1.20
Built against	io.papermc.paper:paper-api:1.20.1-R0.1-SNAPSHOT
Java	17
Dependencies	None required
Optional	MineMail - only for /rally tour load minemail

RallyPoint has no required dependencies. Titles, sounds, and colour come from Paper's built-in Adventure API. MineMail is an optional soft dependency: if it is installed, /rally tour load minemail can build a tour of its mailboxes. Everything else works without it.

Paper only

RallyPoint calls Paper-specific APIs for asynchronous chunk loading and asynchronous teleports. It will not run on plain Spigot or CraftBukkit.

Install steps

1. Download the latest RallyPoint-<version>.jar from the releases page, or build it from source (below).
2. Place the jar in your server's plugins/ directory.
3. Restart the server. RallyPoint creates its data folder and a default config.yml on first run.
4. Edit plugins/RallyPoint/config.yml if you want to change the countdown, scatter radius, or messages.
5. Run /rally reload to apply changes without another restart.

After first start you should see:

plugins/
└── RallyPoint/
    ├── config.yml
    ├── players.yml
    ├── waypoints.yml
    ├── returns.yml
    └── session.yml

players.yml, waypoints.yml, returns.yml, and session.yml appear once there is something to store in them. session.yml holds the live event - the current rally point, any loaded tour and your position in it, and rally history - so a restart mid-event carries on where it left off. A sixth file, stage.yml, exists only while stage mode is active. See Data Files.

Quick start

1. Give your host rally.use and rally.admin, or make them an operator. See Permissions.
2. Ask players to run /rally optin. Nobody is teleported until they do, unless you set default-opt-in: true.
3. As the host, stand where you want the crowd and save a waypoint: /rally waypoint set test.
4. Run /rally go test. You should see a countdown on every opted-in player's screen, then the crowd arriving around you.
5. Run /rally return to put them all back.

Do that dry run at least once before a live event.

Building from source

RallyPoint is a Maven project.

Setting	Value
Group ID	dev.anchorlight
Artifact ID	rallypoint
Main class	dev.anchorlight.rallypoint.RallyPoint
Java source/target	17
Paper API	1.20.1-R0.1-SNAPSHOT

mvn package   # produces target/RallyPoint-1.1.0.jar
mvn test      # runs the MockBukkit test suite

The shaded jar in target/ is the one to drop into plugins/.

Testing notes

The test suite runs against MockBukkit and covers what can be checked off-server: players.yml loading (absent, empty, malformed, and pre-1.0 boolean entries), opt-in state surviving a simulated hard kill, waypoint and return-point persistence, permission gating on every node, tab-completion slots, safety checks and scatter, the rally cooldown, stage mode restoring game modes (including when the plugin is disabled mid-mode), and the rally engine itself through a recording teleporter.

Teleporter isolates the two Paper-specific calls a rally makes, so the rally engine can be driven by tests; Teleporter.Paper is the live implementation.