From c6c1644208804f067ef3c74aa36aedf3df59ca75 Mon Sep 17 00:00:00 2001 From: ez-plugins Date: Sat, 9 May 2026 17:09:09 +0200 Subject: [PATCH] docs: updated docs --- CHANGELOG.md | 6 ++++++ docs/config/rtp.md | 11 ++++++++--- docs/messages-localization.md | 2 +- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e68377f..f2dadf5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,12 @@ Release tags use the `v` prefix (e.g. `v3.0.2`). ### Added +- **Movement-cancel during countdown**: if a player moves too far from their starting position while a countdown is running, the teleport is cancelled. + - `countdown.cancel-on-move` (default `true`) — enable or disable the feature. + - `countdown.cancel-distance` (default `2.0`) — distance in blocks that triggers cancellation. + - `countdown.warn-distance` (default `1.0`) — distance in blocks that sends a one-time warning before cancellation. Set to `0` to disable the warning. + - Two new message keys: `countdown-move-warn` and `countdown-move-cancel` (configurable in `messages/en.yml`). + ### Changed ### Fixed diff --git a/docs/config/rtp.md b/docs/config/rtp.md index 95cb389..fa0e9a7 100644 --- a/docs/config/rtp.md +++ b/docs/config/rtp.md @@ -61,13 +61,15 @@ and per-group cost overrides go in `limits.yml`. ## Countdown -A countdown timer that shows before the teleport happens. Players who move or -take damage during the countdown can have their teleport cancelled (configure -that in `limits.yml`). +A countdown timer that shows before the teleport happens. Players who move too +far during the countdown will have their teleport cancelled. | Key | Default | Description | | :--- | :--- | :--- | | `countdown-seconds` | `5` | How many seconds to count down. `0` disables the countdown entirely. | +| `countdown.cancel-on-move` | `true` | Cancel the teleport if the player moves beyond `cancel-distance` during the countdown. | +| `countdown.cancel-distance` | `2.0` | Distance in blocks from the starting position that triggers cancellation. | +| `countdown.warn-distance` | `1.0` | Distance in blocks that sends a one-time warning before cancellation. Set to `0` to disable the warning. | | `countdown.bossbar.enabled` | `true` | Shows a bossbar with the countdown. | | `countdown.bossbar.title` | *(see below)* | MiniMessage text shown in the bossbar. `` is replaced with the remaining time. | | `countdown.particles.enabled` | `true` | Plays a particle effect around the player during countdown. | @@ -76,6 +78,9 @@ that in `limits.yml`). ```yml countdown-seconds: 5 countdown: + cancel-on-move: true + cancel-distance: 2.0 + warn-distance: 1.0 bossbar: enabled: true title: "Teleporting in seconds..." diff --git a/docs/messages-localization.md b/docs/messages-localization.md index a1caefc..05cbd03 100644 --- a/docs/messages-localization.md +++ b/docs/messages-localization.md @@ -20,7 +20,7 @@ Default language file: - Teleport lifecycle (`teleporting`, `teleport-success`, `teleport-failed`, fallback variants) - Queue (`queue-queued`, `queue-full`) -- Countdown (`countdown-start`, `countdown-tick`) +- Countdown (`countdown-start`, `countdown-tick`, `countdown-move-warn`, `countdown-move-cancel`) - Limits/cooldown (`cooldown`, `limit-daily`, `limit-weekly`) - GUI (`gui-cache-filter-info`, `gui-no-destinations`, `gui-cooldown`) - Network (`network-service-unavailable`, `network-server-offline`)