Gradle-based plugin targeting the latest Paper API (26.2), with configurable races (laps, checkpoints, lobby/start, min players, countdown), a /boatparty command suite, and lap/checkpoint tracking via player movement. Includes Gitea Actions CI to build with JDK 25. Co-Authored-By: Claude Sonnet 5 <[email protected]>
This commit is contained in:
@@ -0,0 +1,47 @@
|
||||
# BoatParty
|
||||
|
||||
An ice-and-boat lap racing minigame for [PaperMC](https://papermc.io/), targeting the latest
|
||||
Minecraft server API (Paper 26.2).
|
||||
|
||||
## How it works
|
||||
|
||||
Build an ice track, place checkpoints along it, and race other players in boats for the
|
||||
fastest lap times over a configurable number of laps.
|
||||
|
||||
## Commands (`/boatparty`, alias `/bp`)
|
||||
|
||||
| Command | Description |
|
||||
|---|---|
|
||||
| `/bp create <name>` | Create a new race |
|
||||
| `/bp delete <name>` | Delete a race |
|
||||
| `/bp setlobby <name>` | Set the waiting-area location (your current position) |
|
||||
| `/bp setstart <name>` | Set the race start/grid location |
|
||||
| `/bp addcheckpoint <name>` | Append a checkpoint at your current position |
|
||||
| `/bp removecheckpoint <name>` | Remove the last checkpoint |
|
||||
| `/bp setlaps <name> <n>` | Set number of laps |
|
||||
| `/bp setminplayers <name> <n>` | Minimum players required to auto-start the countdown |
|
||||
| `/bp setcountdown <name> <seconds>` | Countdown length before a race begins |
|
||||
| `/bp setradius <name> <blocks>` | Checkpoint trigger radius |
|
||||
| `/bp join <name>` / `/bp leave` | Join or leave a race |
|
||||
| `/bp start <name>` / `/bp stop <name>` | Force-start or stop a race (admin) |
|
||||
| `/bp list` / `/bp info <name>` | List races / show race details |
|
||||
|
||||
The last checkpoint added also serves as the finish line — crossing it completes a lap.
|
||||
|
||||
## Permissions
|
||||
|
||||
- `boatparty.admin` (default: op) — configure and control races
|
||||
- `boatparty.play` (default: true) — join and play races
|
||||
|
||||
## Building
|
||||
|
||||
```
|
||||
./gradlew build
|
||||
```
|
||||
|
||||
The compiled plugin jar is produced at `build/libs/BoatParty-<version>.jar`.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Java 21+
|
||||
- PaperMC (latest, built against Paper API 26.2)
|
||||
Reference in New Issue
Block a user