MC Plugin Update Notifier

Multi-source update checker library for Minecraft plugins

Getting Started

Add dependency (JitPack)

<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>
<dependency>
  <groupId>com.github.ez-plugins</groupId>
  <artifactId>github-update-checker</artifactId>
  <version>1.0.0</version>
</dependency>

Create a checker

UpdateChecker checker = UpdateChecker.builder("PVP-Index", "pvpindex-factions", "1.2.3")
        .build();

Run async check

checker.checkNowAsync().thenAccept(result -> {
    if (result.hasError()) {
        getLogger().warning("Update check failed: " + result.getError().orElseThrow().getMessage());
        return;
    }
    if (result.isUpdateAvailable()) {
        getLogger().info("New version: " + result.getLatestVersion().orElse("unknown"));
    }
});