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
Hi,
Thanks for this plugin it's very nice. Can I ask for one feature? Please add function like default restart at and for exampl 03:00.
Doesn't work, says its not up to date upon starting server up...
@craftovski
Not its not that, im running off a VPS host, and im not able to edit the .sh, so i was wondering if theres a way to make it so that it only shuts down the server, then my hosts VPS guard system could bring it back up?
@MrDiceServer
Just press X when server completely stopped and began to start.
Is there a way for it to just stop the server. Not turn it back on?
Can you fix that plugin?
I dont know why but it wont restart on its own, it just kicks players and doesnt do real restart like /stop should do and timer goes into negative -8h-40m-10s
Can u tell me why this happens maybe?
When i set time manualy with /restart m10 server does restart in 10 minutes, and when i use /restart now.
I found this in server log's: [INFO] [SimpleRestart] Something went wrong while saving & stoping! Why that happend and why is that not an WARNING or an SEVERE?
Thanks for the update!
@deleted_8433617
It is up-to-date. Only the readme file isn't.
Can you update github? thx
I have error on shutdown:
@thexsystem
Everything looks fine when using /save-all or /stop.
The message popped up alone at first, then every few resets I saw an error from sign casino after it.
http://pastebin.com/x1wCPrv6
It seems to happen when a slot machine is used when shutting down. When it happens the server doesn't restart (as mentioned) and doesn't attempt anymore restarts after that.
I tested by running a slot machine then doing /stop by itself and nothing happened, it shutdown and started up again.
Sign Casino isn't updated to 1.3. In your opinion do you think that could be the reason? or from the pastebin do you think it could it still happen after an update?
Thanks.
@DoctorBoyd
I have successfully tested it with CraftBukkit 1.3.1-R2.0 (Build 2340) and 1.3.2-R01 (Build 2352). Does any problem occur if you send the command "/save-all" or "/stop" to the server?
@CeramicTitan
On which operating system does your server run? On unix-like OS's (including OSX) you can use a loop like in simple_restart_helper.sh, where you can get out with a simple "/stop" ;-) But I don't know if it's possible to do this on a Windows-OS. If you still need some help with your script, just contact me via private message.
I get the message, "something went wrong when saving and stopping" and it doesn't restart.
Using v1.3.4 and CB 1.3.1 RB 2340
How would you stop the server if its just a loop?
It IS possible to access unapproved downloads. I do this most of the time since it usually takes a while before something is approved ;-)
@Dyadko
YOu do know bukkit has to approve stuff before it is public right? This protects from piracy and makes sure the work he has done is original.
@thexsystem
No download link :(
Just added a new build for CraftBukkit 1.3.1-R2.0 :)