Skip to content

JeremyFail/PluginUpdateChecker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PluginUpdateChecker

License: MIT

This is a library for Minecraft Bukkit / Spigot / Paper server plugins. It is designed to provide easy update checking functionality to any plugin.

This is not a standalone plugin (no plugin.yml): you embed the JAR in your plugin, typically with Maven Shade and package relocation, so multiple plugins can each ship their own copy without classpath conflicts.

The checker runs network work asynchronously, then applies results, events, and optional console/player messages on the main thread. Built-in sources include GitHub Releases (owner/repo), a plain-text URL, or your own supplier. Version comparison uses Maven-style ordering (not naive string compare).

Language / build Java 17+, Maven
Coordinates com.failprooftech:plugin-update-checker:1.0.0 (see pom.xml)
Library version in code PluginUpdateChecker.VERSION

Documentation

Full documentation lives in the GitHub Wiki.

Issues and releases

  • Bug reports and feature requests: use the Issues tab.
  • Published builds: see Releases.

Quick peek

@Override
public void onEnable() {
    PluginUpdateChecker checker = new PluginUpdateChecker(this, "Owner/Repo");
    checker.setDownloadUrl("https://example.com/releases");
    checker.checkNow();
    checker.scheduleRepeating(6, TimeUnit.HOURS);
}

About

A library that Minecraft Spigot/Paper plugin developers can shade into plugins to provide update checking functionality to display in the console and to server operators so they know when a new plugin version is available for download.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages