Paper plugin to bridge Project City Build and its Minecraft server

---

Usage

Prerequisites

• LuckPerms installed on the Minecraft server

How to Install

1. Place the JAR file inside the plugins folder of the Spigot server
2. Run the server at least once to generate the config.yml file
3. Update the generated config file with the required values (eg. API token)
4. Restart the Spigot server

Development

Build

To generate the shaded JAR file

./gradlew shadowJar

Testing

To boot up the development Minecraft server

./gradlew runServer

Then connect to localhost in Minecraft

End-to-end tests

Install the Node.js version configured in .mise.toml with mise, then run the Plugwright tests. Plugwright starts an isolated Paper server and connects real, offline player bots.

mise install
mise exec -- ./gradlew :app:paper-plugin:plugwrightTest

The server workspace, generated tests, and Node dependencies live under app/paper-plugin/src/test/e2e.