Merge pull request #56 from ez-plugins/feature/configurable-countdown-sound

feat: add configurable countdown start/end sounds

Author: ez-plugins

.github/workflows/ci.yml

@@ -93,12 +93,18 @@ jobs:
         uses: actions/setup-java@v5
         with:
           distribution: temurin
-          java-version: ${{ matrix.java }}
+          java-version: '21'
           cache: maven
 
       - name: Build plugin JAR
         run: mvn -B -ntp -DskipTests package
 
+      - name: Switch to runtime JDK ${{ matrix.java }}
+        uses: actions/setup-java@v5
+        with:
+          distribution: temurin
+          java-version: ${{ matrix.java }}
+
       - name: Resolve latest ${{ matrix.platform }} build for MC ${{ matrix.mc-prefix }}.x
         id: server
         run: |
@@ -214,7 +220,7 @@ jobs:
         uses: actions/setup-java@v5
         with:
           distribution: temurin
-          java-version: ${{ matrix.java }}
+          java-version: '21'
           cache: maven
 
       - name: Configure Git for BuildTools
@@ -225,6 +231,12 @@ jobs:
       - name: Build plugin JAR
         run: mvn -B -ntp -DskipTests package
 
+      - name: Switch to runtime JDK ${{ matrix.java }}
+        uses: actions/setup-java@v5
+        with:
+          distribution: temurin
+          java-version: ${{ matrix.java }}
+
       - name: Restore cached Spigot JAR (MC ${{ matrix.mc-prefix }}, Java ${{ matrix.java }})
         id: spigot-cache
         uses: actions/cache@v5

CHANGELOG.md

@@ -12,6 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - **Placeholder formatted output regression tests** - added unit coverage in `EzCountdownPlaceholderExpansionUnitTest` to verify `%ezcountdown_<name>_formatted%` honors `display.time-format.hide-leading-zeros` for both enabled and disabled configurations.
+- **Optional countdown start/end sounds** - countdowns can now define `sounds.start` and `sounds.end` with Bukkit `Sound` enum names in `countdowns.yml`.
+- **GUI sound editors** - the in-game editor now includes dedicated actions to configure and validate start/end sounds, including `none` to disable either sound.
+
+### Changed
+
+- **Runtime start/end flow** - when a configured start/end sound is valid, EzCountdown now plays it to online players at countdown start/end alongside existing message, teleport, firework, and command actions.
 
 ## [2.0.1] - 2026-05-22
 

README.md

@@ -6,9 +6,11 @@ EzCountdown provides configurable countdown timers for events, launches, and mai
 ## Features
 - Fixed date, duration, recurring, and manual countdown modes.
 - Display options: action bar, boss bar (1.9+), chat, title, and scoreboard.
+- Optional start/end sounds per countdown (`sounds.start`, `sounds.end`) using Bukkit `Sound` names.
 - PlaceholderAPI support for `%ezcountdown_<name>_days%`, `_hours`, `_minutes`, `_seconds`, and `_formatted`.
 - Customizable messages (messages.yml), permissions, and update intervals.
 - Run console commands when countdowns finish.
+- GUI editor support for start/end messages, display modes, end commands, and start/end sounds.
 - **Developer API**: send ephemeral one-shot notifications from your plugin without touching YAML (see [API overview](docs/api/README.md)).
 
 ## Commands

docs/api/README.md

@@ -89,6 +89,8 @@ Countdown countdown = CountdownBuilder.builder("launch")
     .formatMessage("countdown.format")
     .startMessage("Server Launching")
     .endMessage("Server Launched")
+    .startSound("ENTITY_PLAYER_LEVELUP")
+    .endSound("BLOCK_NOTE_BLOCK_PLING")
     .zoneId(ZoneId.systemDefault())
     .duration(Duration.ofMinutes(10))
     .build();

docs/api/model/Countdown.md

@@ -26,6 +26,8 @@ Important accessors and behavior:
  - `String getFormatMessage()` - format string used for display messages.
  - `String getStartMessage()` - message broadcasted on start (if configured).
  - `String getEndMessage()` - message broadcasted on end (if configured).
+ - `String getStartSound()` / `void setStartSound(String)` - optional Bukkit `Sound` enum name for start.
+ - `String getEndSound()` / `void setEndSound(String)` - optional Bukkit `Sound` enum name for end.
  - `List<String> getEndCommands()` - commands executed when countdown ends.
  - `ZoneId getZoneId()` - timezone used when resolving fixed/recurring dates.
 
@@ -39,3 +41,5 @@ Runtime fields (mutable):
 Notes
 
 - The constructor establishes the immutable configuration; runtime fields are updated by the plugin when starting/stopping the countdown.
+- `startSound` / `endSound` are optional mutable fields. Passing `null` or blank disables that phase sound.
+- YAML-backed countdowns map these fields to `sounds.start` and `sounds.end`.

docs/configuration.md

@@ -63,6 +63,52 @@ Set per-countdown inside `countdowns.yml` under `display.bossbar`:
 
 ---
 
+## Start/end sounds
+
+Set optional per-countdown sounds in `countdowns.yml`:
+
+| Key | Type | Default | Description |
+|---|---|---|---|
+| `sounds.start` | string | not set | Bukkit `Sound` enum name played when the countdown starts |
+| `sounds.end` | string | not set | Bukkit `Sound` enum name played when the countdown ends |
+
+Notes:
+
+- Sound names must match Bukkit `Sound` enum values (for example `ENTITY_PLAYER_LEVELUP`).
+- If a sound key is missing or blank, no sound is played for that phase.
+- If an invalid sound is configured, EzCountdown logs a warning and continues other start/end actions.
+- The GUI sound editor now prints the full list of sounds available on your running server version.
+
+Common choices:
+
+- `ENTITY_PLAYER_LEVELUP` - positive "start" cue.
+- `BLOCK_NOTE_BLOCK_PLING` - short neutral confirmation.
+- `ENTITY_EXPERIENCE_ORB_PICKUP` - subtle reward-like ping.
+- `UI_BUTTON_CLICK` - lightweight interface-style sound.
+- `BLOCK_BELL_USE` - event bell/chime.
+- `ENTITY_FIREWORK_ROCKET_BLAST` - celebratory end sound.
+- `BLOCK_RESPAWN_ANCHOR_CHARGE` - energetic build-up tone.
+- `ENTITY_ENDER_DRAGON_GROWL` - dramatic finale.
+
+Full references:
+
+- Spigot `Sound` enum: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
+- Paper `Sound` enum: https://jd.papermc.io/paper/1.21/org/bukkit/Sound.html
+
+Example:
+
+```yaml
+countdowns:
+  arena_event:
+    type: DURATION
+    duration: "15m"
+    sounds:
+      start: "ENTITY_PLAYER_LEVELUP"
+      end: "BLOCK_NOTE_BLOCK_PLING"
+```
+
+---
+
 ## Clock-aligned recurring options
 
 Set these per-countdown in `countdowns.yml`:
@@ -118,6 +164,9 @@ countdowns:
       format: "New Year in {formatted}"
       start: "Countdown started!"
       end: "Happy New Year!"
+    sounds:
+      start: "ENTITY_PLAYER_LEVELUP"
+      end: "BLOCK_NOTE_BLOCK_PLING"
     commands_on_end:
       - "broadcast &6Happy New Year!"
     teleport:

docs/feature/gui.md

@@ -17,6 +17,7 @@ Opening the GUI
  - `Main` - see a list of configured countdowns, their running state, and quick start/stop/delete actions.
  - `Display Editor` - pick which `display.types` will show for a countdown and edit per-display settings. For the `BOSS_BAR` display the editor also exposes `color` and `style` options so you can match event themes or improve visibility; the GUI validates input and will show an error if an invalid option is selected.
  - `Messages` - edit `messages.format`, `messages.start`, and `messages.end` templates with live preview.
+ - `Sounds` - edit `sounds.start` and `sounds.end` using Bukkit `Sound` enum names. The editor validates values, supports `none` to disable either sound, and prints the full list of available sounds from your current server version before input.
  - `Commands Editor` - add, remove, or reorder `commands.end` to run console commands when a countdown completes.
 
 Behaviour & saving

docs/index.md

@@ -21,6 +21,7 @@ A feature-rich countdown plugin for Paper/Spigot servers. Create countdowns for
 - **Discord webhooks**  -  post start/end notifications to a Discord channel.
 - **In-game GUI**  -  manage countdowns visually without editing YAML.
 - **Firework shows**  -  trigger configurable firework displays on start or end.
+- **Start/end sounds**  -  optionally play configurable Bukkit sounds when countdowns start or finish.
 - **Teleport actions**  -  move all online players to a named location when a countdown starts or ends.
 - **Console commands on end**  -  run any command when a countdown completes.
 - **Developer API**  -  create, start, stop, listen to countdown events, and send per-player notifications from other plugins.

docs/topics/bbcode-topic.txt

@@ -1,6 +1,6 @@
 [CENTER][SIZE=6][B]EzCountdown[/B][/SIZE]
 [SIZE=3]Run flash sales, timed events, and launches with stunning countdowns - ActionBar, BossBar, Titles & Placeholders![/SIZE]
-[SIZE=2]Spigot, Paper, or Bukkit 1.7-1.21.* • Action bar, boss bar, title, chat, scoreboard • PlaceholderAPI ready[/SIZE][/CENTER]
+[SIZE=2]Paper/Spigot 1.18+ • Java 17+ • Action bar, boss bar, title, chat, scoreboard • PlaceholderAPI ready[/SIZE][/CENTER]
 
 Found an issue or have a question? Please contact me through [URL='https://discord.gg/yWP95XfmBS']the EzPlugins Discord server[/URL].
 
@@ -9,10 +9,12 @@ Found an issue or have a question? Please contact me through [URL='https://disco
 [*][B]Perfect for flash sales & events[/B] - Instantly set up countdowns for shop discounts, launches, or any special event.
 [*][B]Multiple countdown types[/B] - Fixed dates, durations, recurring schedules, or manual timers. Great for launches, resets, or surprise sales.
 [*][B]Flexible displays[/B] - Show timers in action bar, boss bar, title, chat, or scoreboard. Make sure every player sees the excitement.
+[*][B]Start/end sounds[/B] - Configure optional [icode]sounds.start[/icode] and [icode]sounds.end[/icode] per countdown using Bukkit sound names.
 [*][B]Firework shows[/B] - Optional, configurable firework displays for celebration moments. ([COLOR=#ff0000]new[/COLOR])
 [*][B]Permission control[/B] - Limit visibility or management to specific ranks. Keep control in the hands of your staff or VIPs.
 [*][B]PlaceholderAPI support[/B] - Use %ezcountdown_<name>_formatted% and time-part placeholders in any plugin or message.
 [*][B]Config-driven[/B] - Tune update intervals, messaging, and defaults in YAML. No coding required, just edit and reload.
+[*][B]GUI sound editor[/B] - Set or disable countdown sounds directly in the editor with input validation.
 [*][B]Translation variables[/B] - Centralize message text in `messages.yml` and reference keys from `countdowns.yml` using `{translate:key.path}` so owners can reset countdowns without losing localized text.
 [/LIST]
 

docs/topics/markdown-topic.md

@@ -2,16 +2,17 @@
 
 **EzCountdown** is the ultimate custom countdown timer plugin for Minecraft servers. Whether you’re launching a new map, running a flash sale, or celebrating a special event, EzCountdown lets you create, manage, and display any countdown you want, your way.
 
-**Compatible with Spigot, Paper, and Bukkit 1.7–1.21 · Java 8+ · Action bar, boss bar, title, chat & scoreboard displays · PlaceholderAPI ready**
+**Compatible with Paper/Spigot 1.18+ · Java 17+ · Action bar, boss bar, title, chat & scoreboard displays · PlaceholderAPI ready**
 
 ---
 
 ## Why EzCountdown?
 
 - **Create any countdown** – Set up timers for launches, events, sales, or anything you can imagine. Fixed dates, durations, recurring, or manual, your choice.
 - **Flexible displays** – Show countdowns in the action bar, boss bar, title, chat, or scoreboard. Make your timers visible everywhere players look.
+- **Start/end sounds** – Configure optional `sounds.start` and `sounds.end` per countdown using Bukkit sound names.
  - **Easy configuration** – Define countdowns in YAML, customize messages, and reload instantly - no coding required.
- - **Easy configuration** – Define countdowns in YAML, customize messages, and reload instantly - no coding required.
+ - **GUI sound editor** – Set or disable start/end sounds directly from the in-game editor with validation.
  - **Translation variables** – You can keep message text in `messages.yml` and reference it from `countdowns.yml` with the `{translate:key.path}` token. This lets you centralize translations and makes resetting `countdowns.yml` safe because messages are pulled from `messages.yml` at runtime.
 - **Permission control** – Limit who can see or manage each countdown.
 - **PlaceholderAPI support** – Use countdown placeholders in any plugin or message.