SimpleRestart
SimpleRestart
Version 1.3.4 by FuzzyWuzzie and THExSYSTEM
Source
The source of this plugin can be found on GitHub:
Description
SimpleRestart is a plugin for Bukkit (a Minecraft server wrapper) which allows server operators to simply and easily restart their server, as well as schedule automatic restarts of the server "for freshness". The plugin contains flexible yet straightforward commands, is easy to set up and use, and makes use of Permissions.
Setting Up
Simply copy SimpleRestart.jar and the SimpleRestart folder into the "plugins" subdirectory of your minecraft server. If you do not copy in the SimpleRestart folder, it will be created for you automatically, along with a default configuration file. Edit the configuration file (config.yml) as you see fit, then modify your server startup script so that it automatically reboots the server when it gets "/stop"ped.
The Configuration File
The default configuration file is mostly straight forward and contains numerous comments. However, each option is detailed below:
- auto-restart: enable / disable automatic, time-scheduled restarting. If this is set to "no" then the server will only ever restart when using the "/restart" command.
- auto-restart-interval: this is how often (in hours) the server will automatically restart itself (only if auto-restart is set to "yes")
- warn-times: Before the server restarts, it will send out a friendly warning to all connected players, this setting is a list that describes the amount of time (in minutes) before the server automatically reboots that players are warning. For example: warn-times: [10, 5, 2, 1] will warn players at 10 minutes, 5 minutes, 2 minutes, and 1 minute before the server reboots.
- warning-message: this is the message that will be displayed as a warning that the server will be restarting soon. You may use classic minecraft server colour codes (http://www.minecraftwiki.net/wiki/Classic_server_protocol#Color_Codes) and "%t"% to indicate how long before the server reboots. For example: warning-message: "&cServer will be restarting in %t minutes!" will display "Server will be restarting in 5 minutes!" in red (with warn-time = 5)
- restart-message: this is the message that players will see when they are kicked from the server due to the automatic reboot. Again, color codes can be used here.
Editing Your Startup Script
In order for this plugin to work properly, you will have to make a slight modification to your startup script (craftbukkit.bat on windows, craftbukkit.sh on Linux). This plugin works by simply scheduling regular "stops" of the server. Then when the server goes down, the startup script simply loops around and starts the server up again, with minimal mumbo-jumbo.
To differ between a real "/stop" and just a "/restart" you have to check the modification time of the file SimpleRestart/restart.txt in your plugins directory. If a real "/stop" was called then the modification time of the file remains the same. Otherwise, if just a "/restart" was called, the modification time will be changed. There is a helper script für *nix OSes which implements this: simple_restart_helper.sh
This is accomplished in the startup scripts using infinite loops:
- For Windows, put ":start" on the line before what you want repeated, then "goto start" on the line after what you want repeated to make an infinite loop. Example craftbukkit.bat:
@ECHO OFF SET BINDIR=%~dp0 CD /D "%BINDIR%" :start "%ProgramFiles%\Java\jre6\bin\java.exe" -Xmx1024M -Xms1024M -jar craftbukkit.jar goto start
- For *nix OSes, put "while true" <new line> "do" on the lines before what you want repeated, and "done" on the line after to make an infinite loop. Example craftbukkit.sh:
#!/bin/sh BINDIR=$(dirname "$(readlink -fn "$0")") cd "\$BINDIR" while true do java -Xmx1024M -Xms1024M -jar craftbukkit.jar echo "If you want to completely stop the server process now, press Ctrl+C before the time is up!" echo "Rebooting in:" for i in 5 4 3 2 1 do echo "$i..." sleep 1 done echo "Rebooting now!" done
On Windows, to exit this infinite loop (i.e., take the server down for good), simply close the command window. On Linux, stop the server then press "Ctrl+C" to cancel the process.
Permissions Nodes
The following permissions can be configured:
- simplerestart.restart to use just about anything in the /restart or /reboot commands, users must have the permission
- simplerestart.time to use the /restart time command, users must have the permission
- simplerestart.memory to use the /memory command, users must have the permission
- Note: simplerestart.* shouldn't work
Commands
All commands may be typed in the console (without the "/" of course) or by players in-game:
- /restart help: gives a simple help menu
- /restart now: restarts the server immediately
- /restart time: informs you how much time is left before the server restarts
- /restart (h|m|s) <time>: turns automatic restarting on (if it was off) and reschedules the next automatic restart to be <time> (hours, minutes, or seconds) away from now. For example, to reboot the server in 15 minutes, use "/restart m 15". 'h' is for hours, 'm' is for minutes, and 's' is for seconds.
- /restart on: turns automatic restarting on (if disabled in configuration OR via commands. Will start the scheduler from the current time based on the settings in the configuration.
- /restart off: cancels any pending automatic restarts and prevents automatic restarts from happening until re-enabled
- /memory: displays the java runtime memory usage, useful for catching runaway plugins
Changelog
- 1.3.4 Updated to Bukkit v1.3.1-R2.0
- 1.3.3 Updated to Bukkit v1.2.4-R1.0
- 1.3.2 Updated to Bukkit v1.2.3-R0.1
- 1.3.1 Updated to Bukkit v1.1-R6. Added support for bPermissions and PermissionsEx.
- 1.3.0 Updated to Bukkit v1.1-R1
- 1.2.0 Changed the scheduling system from Bukkit's internal scheduler (which gets delayed in the event of lag) to Java timers, which should be server lag-proof.
- 1.1.0 Added multiple warnings and tidied up code a bit
- 1.0.1 Added forced auto-save before reboot and separate permissions node for checking how long before restart
- 1.0.0 Initial release
@nhadobas
It does make sense, however, being that it uses a shell script that is triggered on server stopping, I don't really see the functionality of making it save the remaining time until the next restart, being that one has already occurred. However, the /reload not restarting the timer would make sense, however, I still would not suggest reloading your server, it is much safer to restart it.
@xclucky
Not only does the plugin restart on /reload, it also restarts if your server does. So people who are editing their server cant rely on the simplerestart. It's just a suggestion.
@nhadobas
It is not recommended to reload you server anyway, it causes lots of plugin errors.
@nhadobas
Also, this needs to be updated so that a /reload doesnt reset the restart time...
How do i edit my start up script if i bought a server online?
Is the script posted above compatible with Java 7 and/or Tekkit?
I am just wondering if this plugin works for mac users?
I do the command /restart now, and it just stops my server. The server does not infact "restart" itself I have to start it back up. Any Suggestions? Also is there anyway you could make it do /save-all before it auto restarts?
2 words. F** AMAZING!!!!
This plugin is AMAZING! I've been needing a plugin like this for a long time! I confirm it working on 1.2.5-R.3.0. It restarts my shell script no problem on Ubuntu 12.04 Precise Pangolin Server Edition. Keep up the good work!
hi hello :D
it would be great if u please update ur plugin i love 2 use it
It seems that whenever I edit any of my sever files, this restart plugin will fail to work without a complete manual server restart. This includes any of my plugins' config files or even my whitelist.txt
Please look into this, as I have to make changes to my server daily!
Hi. i have CB 1.2.5 r1.3 and SimpleRestart v1.3.3 and i have issue, when it comes time to do reload my server is hung and console not response to any command. I think this is started when i add inventorySQL plugin, but i dont see any error in console. Can you help me?
Its a great plugin! THX
Yeah, such a great plugin guys. Keep working on it :).
Great plugin please keep updating it !!
@xDVGx
Take a look at comment #40. He has a timeout of 5 seconds between the restart, where you could manually kill the process.
@Davyhalliday
Sorry, it's not possible yet. But this feature sounds really cool :) I think I will implement this next.
Is tehre any way of running a command before every restart? The factions file needs /f saveall before every restart
When I type /stop it restarts the server lol... I cant stop my server help please Running windows
here is the contents of my "
[RUN].bat"@ECHO OFF SET BINDIR=%dp0 CD /D "%BINDIR%" :start "C:\Program Files\Java\jre7\bin\java.exe" -Xmx1024M -Xms1024M -jar craftbukkit*.jar goto start