PluginPulse

Your plugins stay up to date, and you decide how far it goes.

Most servers find out a plugin is outdated the hard way,
from a crash, a security warning, or a player telling them.

PluginPulse checks where your plugins publish their updates,
tells you when one is out, and can install it for you.

Without PluginPulse	With PluginPulse
Visit every plugin page to see what's new	One list shows what's behind
Download, rename and copy jars by hand	One command, or fully automatic
A bad download breaks your server	Every download is checked before it's used
A broken update means hunting for the old jar	`/pluginpulse restore` puts it back
The wrong jar for your Minecraft version	The one made for your server, picked for you

Setup

Drop the jar into plugins/ and start the server
List the plugins you want kept up to date in plugins/PluginPulseCompanion/config.yml
Run /pluginpulse reload

plugins:
  EssentialsX:              # the name /plugins shows
    modrinth: essentialsx   # where its updates come from
    mode: notify            # tell me, download nothing

The plugins you list don't need to know PluginPulse exists.

What it does

Finds updates

Checks Modrinth, GitHub, Hangar, a Jenkins build server, or a web address you host
Give a plugin more than one place to check, in the order you choose
When a plugin makes separate downloads for 1.21 and 26.x, you get the one for your server

Tells you

A notice in the console and in game for anyone with pluginpulse.admin
Click the notice to open the download page, or run /pluginpulse download to install it

Installs, only if you let it

Each plugin gets its own mode, from "just tell me" to fully automatic
Every download is checked against the checksum the author published. A damaged or tampered file is never used
The old jar is backed up first, and the update is applied on your next restart

Waits out brand-new releases, if you like

Sometimes an update is broken and fixed a few hours later
Switch on hold-new-updates and PluginPulse waits until a release has been out for 18 hours
/pluginpulse download <plugin> still installs one right away

Will it work on my server?


Server software	Paper, Folia, Spigot, or a Paper fork like Purpur
Minecraft	1.20.5 to 1.21.x with the plain download, 26.x (including 26.3) with the `-mc26` download
Java	21+ for 1.21.x, 25+ for 26.x
Anything else	Nothing. No dependencies

On Spigot, notices are plain text with the link written out, instead of clickable.

Reference

Commands

Command	What it does
`/pluginpulse`	Every managed plugin, and whether it's up to date
`/pluginpulse check [plugin\|all]`	Check now
`/pluginpulse download [plugin\|all]`	Download the update, ready for the next restart
`/pluginpulse apply [plugin\|all]`	Install a downloaded update without a restart (needs `hot-reload: true`)
`/pluginpulse restore [plugin\|all]`	Go back to the previous version on the next restart
`/pluginpulse reload`	Re-read the settings file

Also works as /ppc or /pulse.

Permissions

Permission	What it does	Default
`pluginpulse.admin`	Use the commands and see update notices	OP

Modes

Mode	What happens when an update is found
`off`	Nothing, this plugin is ignored
`check-only`	Nothing, until you run `/pluginpulse`
`notify` (default)	You're told in the console and when you join. Nothing is downloaded
`download`	It's downloaded and checked, ready for your next restart
`auto-stage`	Same as `download`, as soon as the update is found

Settings people change

plugins:
  SomePlugin:
    github: owner/repo           # or modrinth, hangar, jenkins
    mode: download
    hot-reload: false            # true = install without a restart, when it's safe
    match-server-version: true   # take the download made for your Minecraft version

user-agent-contact: "you@example.com"   # Modrinth asks for a way to reach you
check-interval-hours: 6
hold-new-updates: false          # true = wait until a release has been out a while
hold-new-updates-hours: 18

More info? Read about it in the guide

Making your own plugin update itself

PluginPulse is also a library. Add it to your plugin and it updates itself, with the same checks, notices and backups.

dependencies {
    implementation("com.github.darkstarworks.PluginPulse:pluginpulse-core:v0.9.0")
}
tasks.shadowJar {
    relocate("io.github.darkstarworks.pluginpulse", "my.plugin.libs.pluginpulse")
}

Then either drop a pluginpulse.yml into your resources and call PluginPulse.bootstrap(this), or use the builder for full control.

More info? Read about it in the library guide

Adding updates to a jar you can't rebuild

Have a plugin jar but no source code? The browser tool adds an updater to it. Pick the jar, say where its updates come from, and download the new jar.

Everything happens on the page. Your jar is never uploaded.

More info? Read about it in the browser tool guide

Help

Discord - ask me directly. Tell me "if it did X, I'd use it" and there's a good chance it ships
Guide - setup, plus where to find a plugin's updates and a glossary
Bug reports, Source, Changelog

Paper, Folia, Spigot
Minecraft 1.20.5 to 26.x, Java 21+
No dependencies

Free and source available.
Please consider donating: Ko-Fi or Patreon

Did you know I have other plugins? Check them out here

Compatibility

Minecraft: Java Edition

Platforms

Links

Creators

Details

What it does

Will it work on my server?

Reference

Help