Automatically update GeyserMC on spigot, velocity, and bungeecord servers.
If you'd like, click here to join our Discord server! You can come here to receive support, ask about contributing, get GitHub feeds, or just simply hang out. Please do not ping anyone that doesn't have the "Pingable" role!
Note: This is NOT an official GeyserMC plugin. It is made to work with Geyser, but it is not maintained or produced by GeyserMC. If you need support with this plugin, please do not ask the Geyser developers — instead, please go to our Discord server which is linked above.
Please download the plugin from our Spigot page, so we can get an idea of how many people are downloading the plugin.
If you don't want to use the Spigot website, you can download the plugin from our CI, or use the actions button in the GitHub bar and download the zip with the GeyserUpdater jar inside.
GeyserUpdater can be installed on Spigot, BungeeCord, and Velocity (or any of their forks, such as Paper or Waterfall).
Simply place the GeyserUpdater *.jar
file in your server's plugins folder and restart your server.
Commands | Permission |
---|---|
/geyserupdate |
gupdater.geyserupdate |
After you run the /geyserupdate
command or enable auto-updating, GeyserUpdater will check the currently-installed version of Geyser. If it's outdated, GeyserUpdater will automatically download the latest build of Geyser. Changes will only take place once the server has been shut down and restarted.
Please note that for BungeeCord and Velocity, if the server is not shut down cleanly, the new version of Geyser will not be applied.
Auto-Update-Geyser
:Default: false
If enabled, GeyserUpdater will check for new Geyser builds on server start, and on the interval specified by Auto-Update-Interval
. If a new build exists, it will be downloaded.
Auto-Update-Interval
:Default: 24
The interval in hours between each auto update check.
Auto-Restart-Server
:Default: false
If enabled, GeyserUpdater will attempt to restart the server 10 seconds after a new version of Geyser has been successfully downloaded.
Spigot: Attempts to restart using Spigot's /restart
. A restart script must be defined in spigot.yml in order for Spigot's restart feature to work properly. If you are using a hosting provider, a server wrapper, or a systemd
unit (or similar) to run the server, leave the restart-script
value in spigot.yml blank. Your server should automatically restart without needing a script.
BungeeCord/Velocity: The server will simply stop. If you are using a hosting provider, a server wrapper, or a systemd
unit (or similar) to run the server, your proxy should automatically restart. If not, you can use a script to start the proxy that will make it start again once it has stopped.
Auto-Script-Generating
:Default: false
Do not use this if you are using a hosting provider, a server wrapper, or a systemd
unit (or similar) to run your server.
When enabled, a restart script named ServerRestartScript.sh
(macOS, Linux) or ServerRestartScript.bat
(Windows) will be generated for you. It will attempt to use the same JVM flags that your server started with. Although it should typically work without any issue, it is recommended to verify and modify the generated script to your liking.
Spigot: The restart-script
value in spigot.yml will be automatically set to use the generated restart script. This will allow Spigot's restart feature to work if you have Auto-Restart-Server
enabled, and if you run /restart
. If you are running your server on Linux, it is recommended to modify the script so that your server starts in a screen or tmux session so that you can attach to the console of the server after it has restarted.
BungeeCord/Velocity: You must use the generated script to start the proxy. This will make the server restart after it has stopped.
Restart-Message-Players
:Default: '&2This server will be restarting in 10 seconds!'
This is the message that is sent to all players when Auto-Restart-Server
is going to restart the server in 10 seconds.
Special thanks to: