EzCountdown Public API

Prerequisites

Java 21 (matches Paper API classfile version used by the plugin).
Access to the GitHub Packages repository

Quick start

Follow these steps to add and use the EzCountdown API from your plugin.

Installation

1) Add the GitHub Packages repository to your pom.xml (replace owner/repo if different):

<repositories>
    <repository>
        <id>github</id>
        <name>ez-plugins</name>
        <url>https://maven.pkg.github.com/ez-plugins/EzCountdown</url>
    </repository>
</repositories>

2) Add the dependency (use the published version tag):

<dependency>
    <groupId>com.skyblockexp</groupId>
    <artifactId>ezcountdown</artifactId>
    <version>1.3.1</version>
</dependency>

Service lookup

Getting the API

Use Bukkit’s ServicesManager to obtain a reference to the EzCountdownApi service. The example below shows the common pattern used in other plugins:

import com.skyblockexp.ezcountdown.api.EzCountdownApi;
import org.bukkit.Bukkit;
import org.bukkit.plugin.RegisteredServiceProvider;

RegisteredServiceProvider<EzCountdownApi> rsp = Bukkit.getServicesManager().getRegistration(EzCountdownApi.class);
if (rsp == null) {
    // EzCountdown not available
    return;
}
EzCountdownApi api = rsp.getProvider();

Examples

Start/Stop

Start an existing countdown by id:

api.startCountdown("example-countdown");

Stop a running countdown:

api.stopCountdown("example-countdown");

Create

Create a countdown using CountdownBuilder:

import com.skyblockexp.ezcountdown.api.model.Countdown;
import com.skyblockexp.ezcountdown.api.model.CountdownType;
import com.skyblockexp.ezcountdown.api.model.CountdownBuilder;
import com.skyblockexp.ezcountdown.display.DisplayType;
import java.time.ZoneId;
import java.time.Duration;
import java.util.EnumSet;

Countdown countdown = CountdownBuilder.builder("launch")
    .type(CountdownType.DURATION)
    .displayTypes(EnumSet.of(DisplayType.ACTION_BAR, DisplayType.TITLE))
    .updateIntervalSeconds(1)
    .formatMessage("countdown.format")
    .startMessage("Server Launching")
    .endMessage("Server Launched")
    .zoneId(ZoneId.systemDefault())
    .duration(Duration.ofMinutes(10))
    .build();

api.createCountdown(countdown);
api.startCountdown("launch");

Inspect

Inspect or list countdowns:

Optional<Countdown> maybe = api.getCountdown("launch");
Collection<Countdown> all = api.listCountdowns();

Javadoc & API reference

See the generated API docs for full type and method details: docs/api/EzCountdownApi.md and the model/ and event/ pages in this folder. If you want, I can add a GitHub Pages workflow to publish hosted Javadoc automatically on release.