Skip to content

Home

Jump to bottom
Jeremy Fail edited this page Apr 4, 2026 · 9 revisions

PluginUpdateChecker

PluginUpdateChecker is a small library for Spigot/Paper plugin developers. Add it to your plugin, shade and relocate it, then call it from onEnable (or elsewhere) to compare your plugin’s version to a remote "latest" string and optionally notify the console and players.

  • Not a plugin - there is no plugin.yml; it is code you embed.
  • Threading - fetches run async; events and Bukkit-facing callbacks run sync on the main thread.
  • Issues & releases - Issues · Releases

Documentation

  1. Building and shading - mvn package, dependency, Maven Shade, relocation.
  2. Version sources and comparison - GitHub, plain URL, custom supplier; Maven-style compare.
  3. Running checks, scheduler, HTTP - checkNow, repeating schedule, User-Agent, timeouts.
  4. Events, callbacks, notifications - PluginUpdateCheckEvent, success/failure hooks, console/player output, join notices.
  5. Links, state, relocation, types - download URLs, getters, relocation warning, chat stack, package list.

Clone this wiki locally