Skip to content

docs: updated docs #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ez-plugins merged 1 commit into from
May 9, 2026
Merged

docs: updated docs #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 8 additions & 3 deletions docs/config/rtp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. `<seconds>` is replaced with the remaining time. |
| `countdown.particles.enabled` | `true` | Plays a particle effect around the player during countdown. |
Expand All @@ -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: "<yellow>Teleporting in <white><seconds></white> seconds...</yellow>"
Expand Down
2 changes: 1 addition & 1 deletion docs/messages-localization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down
Loading