This project builds lightweight Folia and Canvas plugins that give players useful TPS information without exposing server region details, coordinates, or other player positions.
The two platform plugins share their configuration, output formatting, and TPS command implementation. Platform entry points and TPS providers are kept separate so Folia- or Canvas-specific APIs can evolve independently.
Run ./gradlew platformJars to build both artifacts and copy them to the top-level dist directory:
dist/FoliaLocalTPS-1.0.1.jardist/CanvasLocalTPS-1.0.1.jar
| Command | Description | Access |
|---|---|---|
/tps-all |
Shows both local region TPS and global TPS. | Everyone |
/tps-local |
Shows only the player's current local region TPS. | Everyone |
/tps-global |
Shows only the server's global TPS. | Everyone |
/folialocaltps reload |
Reloads the Folia plugin configuration. | folialocaltps.reload |
/canvaslocaltps reload |
Reloads the Canvas plugin configuration. | canvaslocaltps.reload |
Folia's native /tps command is not replaced or overridden.
| Permission | Default | Description |
|---|---|---|
folialocaltps.execute |
true |
Documents access to the public TPS commands. |
folialocaltps.reload |
op |
Allows reloading the plugin configuration. |
| Permission | Default | Description |
|---|---|---|
canvaslocaltps.execute |
true |
Documents access to the public TPS commands. |
canvaslocaltps.reload |
op |
Allows reloading the plugin configuration. |
The public TPS commands are intentionally available to all players by default.
Player-facing TPS output does not include:
- Coordinates
- Region IDs
- Chunk positions
- Other player locations
When debug: true is enabled in config.yml, location information may be logged to console for testing and troubleshooting only.