ServerRestarter

Table of Contents

ServerRestarter

About

ServerRestarter is a highly configurable server restart management plugin. Through this plugin, you can set an infinite amount of messages to display and sounds to play at specific intervals. You can also enable scoreboard display (fully configurable) to inform users continuously about an oncoming restart. The /sr command is provided to trigger a restart manually or update the time until next restart and restart message. Time format in commands and config is 0d0h0m0s0ms (e.g. 3h30m, 5s500ms). Chat color format in commands and config is &code, where code is the color code.

NOTE: /restart command is currently broken, as bukkit/spigot override this command yet do not automate it; use /sr instead. NOTE: A script (listed below) is required for the restart to actually work, otherwise the server will simply shut down as usual.

Features

Completely configurable restart actions. (Restart actions are dynamic, not by index as in every other restart plugin.)
Restart actions come as either message, sound, or scoreboard action.
Optional scoreboard display allows every option to be configured: title, location, text format. These can be changed at intervals via action.
Command to control restarts and restart settings.
State file creation to indicate to scripts that a server wishes to be restarted.

Commands

/sr Trigger a restart instantly.
/sr [time] Set the restart time to [time].
/sr [message] Set the restart kick message to [message]. NOTE: If the message starts with a valid time format, it will be treated as the command below.
/sr [time] [message] Set both time and message simultaneous.
/sr reset Reset the time and message to default settings (restarting the timer). Permission node is sr.restart (or server operator).

Config

This is an example configuration file (automatically generated by the plugin).

# Time before restarting the server.
# Format is 0d0h0m0s0ms.
restart_time: 3h
kick_message: Server is restarting! Come back in a minute or two!
# ServerRestarter will create this file in the base server directory
# every time the plugin is enabled, and will
# delete it upon being disabled given that the server is not restarting.
# By not deleting it until being disabled, it guarantees that a server crash will cause a restart (as the plugin is not disabled in a crash).
# This option is useful for scripts to detect if the server shut down for a restart or crash.
state_file: auto_restart
create_state_file: 'true'
actions:
  # You may specify as many of these as you want. Name does not matter; value is the action.
  # Currently accepted formats are:
  #   message:<time>:<message>
  #   sound:<time>:<sound>:<volume>:<pitch>
  #   scoreboard:<time>:enable|disable|settitle:<title>|setformat:<d|h|m|s|ms>:<text>
  # List of sounds can be found at http://jd.bukkit.org/rb/apidocs/org/bukkit/Sound.html.
  message_5m: message:5m:&aServer will restart in 5 minutes...
  scoreboard_5m_title: scoreboard:5m1ms:settitle:Restart Time
  scoreboard_5m_format: 'scoreboard:5m1ms:setformat:m:&aMinutes left:'
  scoreboard_5m_enable: scoreboard:5m:enable
  sound_5m: sound:5m:NOTE_PIANO:1.0:3.0
  message_2m: message:2m:&aServer will restart in 2 minutes...
  message_1m: message:1m:&aServer will restart in 1 minute...
  sound_1m: sound:1m:NOTE_PIANO:1.0:2.0
  sound2_1m: sound:1m:NOTE_BASS_GUITAR:1.0:2.0
  scoreboard_1m_format: 'scoreboard:1m:setformat:s:&eSeconds left:'
  message_30s: message:30s:&aServer will restart in 30 seconds...
  sound_30s: sound:30s:NOTE_PIANO:1.0:1.0
  scoreboard_30s_format: 'scoreboard:30s:setformat:s:&6Seconds left:'
  message_15s: message:15s:&aServer will restart in 15 seconds...
  sound_15s: sound:15s:NOTE_PIANO:1.0:1.0
  scoreboard_15s_format: 'scoreboard:15s:setformat:s:&cSeconds left:'
  message_10s: message:10s:&aServer will restart in 10 seconds...
  sound_10s: sound:10s:NOTE_PIANO:1.0:1.0
  message_5s: message:5s:&aServer will restart in 5 seconds...
  scoreboard_5s_format: 'scoreboard:5s:setformat:s:&4Seconds left:'
  sound_5s: sound:5s:NOTE_PIANO:1.0:1.0
  sound_5s300ms: sound:5s300ms:NOTE_PIANO:1.0:1.0
  message_4s: message:4s:&aServer will restart in 4 seconds...
  sound_4s: sound:4s:NOTE_PIANO:1.0:1.0
  sound_4s300ms: sound:4s300ms:NOTE_PIANO:1.0:1.0
  message_3s: message:3s:&aServer will restart in 3 seconds...
  sound_3s: sound:3s:NOTE_PIANO:1.0:1.0
  sound_3s300ms: sound:3s300ms:NOTE_PIANO:1.0:1.0
  message_2s: message:2s:&aServer will restart in 2 seconds...
  sound_2s: sound:2s:NOTE_PIANO:1.0:1.0
  sound_2s300ms: sound:2s300ms:NOTE_PIANO:1.0:1.0
  message_1s: message:1s:&aServer will restart in 1 second...
  sound_1s: sound:1s:NOTE_PIANO:1.0:1.0
  sound_1s300ms: sound:1s300ms:NOTE_PIANO:1.0:1.0
  sound_1s600ms: sound:1s600ms:NOTE_PIANO:1.0:1.0

More readable, alternative script (equivalent to the one above):

# Time before restarting the server.
# Format is 0d0h0m0s0ms.
restart_time: 3h
kick_message: Server is restarting! Come back in a minute or two!

# ServerRestarter will create this file in the base server directory every time the plugin is enabled, and will delete it upon being disabled given that the server is not restarting.
# By not deleting it until being disabled, it guarantees that a server crash will cause a restart (as the plugin is not disabled in a crash).
# This option is useful for scripts to detect if the server shut down for a restart or crash.
state_file: auto_restart
create_state_file: 'true'

# You may specify as many of these as you want. Name does not matter; value is the action.
# Currently accepted formats are:
#   message:<time>:<message>
#   sound:<time>:<sound>:<volume>:<pitch>
#   scoreboard:<time>:enable|disable|settitle:<title>|setformat:<d|h|m|s|ms>:<text>
# List of sounds can be found at http://jd.bukkit.org/rb/apidocs/org/bukkit/Sound.html.
actions:
  5m_msg: 'message:5m:&aServer will restart in 5 minutes...'
  5m_scb_title: 'scoreboard:5m1ms:settitle:Restart Time'
  5m_scb_format: 'scoreboard:5m1ms:setformat:m:&aMinutes left:'
  5m_scb_enable: 'scoreboard:5m:enable'
  5m_snd: 'sound:5m:NOTE_PIANO:1.0:3.0'
  2m_msg: 'message:2m:&aServer will restart in 2 minutes...'
  1m_msg: 'message:1m:&aServer will restart in 1 minute...'
  1m_snd: 'sound:1m:NOTE_PIANO:1.0:2.0'
  1m_snd2: 'sound:1m:NOTE_BASS_GUITAR:1.0:2.0'
  1m_scb_format: 'scoreboard:1m:setformat:s:&eSeconds left:'
  30s_msg: 'message:30s:&aServer will restart in 30 seconds...'
  30s_snd: 'sound:30s:NOTE_PIANO:1.0:1.0'
  30s_scb_format: 'scoreboard:30s:setformat:s:&6Seconds left:'
  15s_msg: 'message:15s:&aServer will restart in 15 seconds...'
  15s_snd: 'sound:15s:NOTE_PIANO:1.0:1.0'
  15s_scb_format: 'scoreboard:15s:setformat:s:&cSeconds left:'
  10s_msg: 'message:10s:&aServer will restart in 10 seconds...'
  10s_snd: 'sound:10s:NOTE_PIANO:1.0:1.0'
  5s_msg: 'message:5s:&aServer will restart in 5 seconds...'
  5s_scb_format: 'scoreboard:5s:setformat:s:&4Seconds left:'
  5s_snd: 'sound:5s:NOTE_PIANO:1.0:1.0'
  5s300ms_snd: 'sound:5s300ms:NOTE_PIANO:1.0:1.0'
  4s_msg: 'message:4s:&aServer will restart in 4 seconds...'
  4s_snd: 'sound:4s:NOTE_PIANO:1.0:1.0'
  4s300ms_snd: 'sound:4s300ms:NOTE_PIANO:1.0:1.0'
  3s_msg: 'message:3s:&aServer will restart in 3 seconds...'
  3s_snd: 'sound:3s:NOTE_PIANO:1.0:1.0'
  3s300ms_snd: 'sound:3s300ms:NOTE_PIANO:1.0:1.0'
  2s_msg: 'message:2s:&aServer will restart in 2 seconds...'
  2s_snd: 'sound:2s:NOTE_PIANO:1.0:1.0'
  2s300ms_snd: 'sound:2s300ms:NOTE_PIANO:1.0:1.0'
  1s_msg: 'message:1s:&aServer will restart in 1 second...'
  1s_snd: 'sound:1s:NOTE_PIANO:1.0:1.0'
  1s300ms_snd: 'sound:1s300ms:NOTE_PIANO:1.0:1.0'
  1s600ms_snd: 'sound:1s600ms:NOTE_PIANO:1.0:1.0'

Scripts

Linux:

#!/bin/bash

JAVA="java"
JAVA_OPTS="-Xms1024M -Xmx1024M"
SERVER_JAR="server.jar"
STATE_FILE="auto_restart"

while true
do
    $JAVA $JAVA_OPTS -jar $SERVER_JAR
    if [ ! -e $STATE_FILE ]
    then
        break
    fi
    echo "Restarting server in 5 seconds! Kill the process with 'ctrl+c' to prevent it from rebooting or use /stop when the server has rebooted."
    for i in {5..1}
    do
        echo "$i..."
        sleep 1
    done
    echo "Restarting!"
done

Windows: (untested- sorry, not on this OS :( let me know if it works)

@ECHO OFF
SET JAVA=java
SET JAVA_OPTS=-Xms1024M -Xmx1024M
SET SERVER_JAR=server.jar
SET STATE_FILE=auto_restart
:START
%JAVA% %JAVA_OPTS% -jar %SERVER_JAR%
IF NOT EXIST %STATE_FILE% EXIT
ECHO Restarting server in 5 seconds! Close the command prompt to prevent it from rebooting or use /stop when the server has rebooted.
FOR /l %X IN (5, -1, 1) DO (
    ECHO %X%...
    TIMEOUT 1
)
GOTO START

Alternative Windows (in case the above script does not work):

@ECHO OFF
:START
java -Xms1024M -Xmx1024M -jar server.jar
IF NOT EXIST auto_restart EXIT
GOTO START

Change the options in either script as you see fit. These will restart your server if a file named 'auto_restart' is found (configurable), otherwise exit.

Source

https:github.com/DarkStorm652/ServerRestarter

Comments

Forge_User_06259004
- Join Date: 4/16/2018
- Posts: 3
- Member Details
#17 Forge_User_06259004

View User Profile

Send Message

Posted Feb 6, 2019
hey, you have a great plugin, but i want to remove it. But it is not in the plugins folder.
How i remove it?

Rollback Post to Revision RollBack
Goshen_Ithilien
- Location: Salt Lake City, Utah
- Join Date: 3/21/2013
- Posts: 55
- Member Details
#16 Goshen_Ithilien

View User Profile

Send Message

Posted Oct 21, 2016
This is/was a fantastic plugin, we still use it on our old servers.

I requested someone port it to Sponge- https://forums.spongepowered.org/t/server-restarter-port/15375

Rollback Post to Revision RollBack
_ForgeUser16041361
- Join Date: 6/25/2014
- Posts: 1
- Member Details
#15 _ForgeUser16041361

View User Profile

Send Message

Posted Jun 25, 2014
Do I put the Linux script in the "auto_restart" file ?

Last edited by _ForgeUser16041361: Jun 25, 2014

Rollback Post to Revision RollBack
gizmogadget3
- Join Date: 12/19/2011
- Posts: 28
- Member Details
#14 gizmogadget3

View User Profile

Send Message

Posted Feb 14, 2014
update to 1.7.X please ?

Rollback Post to Revision RollBack
_ForgeUser9956241
- Join Date: 11/10/2012
- Posts: 9
- Member Details
#13 _ForgeUser9956241

View User Profile

Send Message

Posted Dec 2, 2013
Hey. This plugin looks really, really good-but could you include a mac script? I know how Terminal etc. works, but I'm a bit in the woods here.

Thanks!

Rollback Post to Revision RollBack
_ForgeUser12461807
- Join Date: 10/19/2013
- Posts: 39
- Member Details
#12 _ForgeUser12461807

View User Profile

Send Message

Posted Oct 27, 2013
What is the script for mac?

Rollback Post to Revision RollBack
_ForgeUser12111366
- Join Date: 8/31/2013
- Posts: 4
- Member Details
#11 _ForgeUser12111366

View User Profile

Send Message

Posted Oct 6, 2013
It just stops the server it doesn't start back up

Rollback Post to Revision RollBack
Forge_User_08993432
- Join Date: 10/22/2011
- Posts: 136
- Member Details
#10 Forge_User_08993432

View User Profile

Send Message

Posted Sep 2, 2013
Ive got a linux server Running MineOS, where exactly am i mean to be putting this script?. Im a bit clueless about editing linux acutally

Last edited by Forge_User_08993432: Sep 2, 2013

Rollback Post to Revision RollBack
_ForgeUser11973497
- Join Date: 8/3/2013
- Posts: 5
- Member Details
#9 _ForgeUser11973497

View User Profile

Send Message

Posted Aug 31, 2013
@FranticIch

That is intended behavior. If you type /stop the server will shutdown normally without restarting by deleting that file (the restart script will only restart if that file is present). Type /sr to restart the server rather than shutting it down.

Rollback Post to Revision RollBack
_ForgeUser7615135
- Join Date: 9/27/2011
- Posts: 4
- Member Details
#8 _ForgeUser7615135

View User Profile

Send Message

Posted Aug 31, 2013
The "auto_restart" file deletes itself sometimes - is that a bug or did I do something wrong?

Edit: It seems to happen when I "/stop" the server. (I'm using Ubunu, Linux)

Last edited by _ForgeUser7615135: Aug 31, 2013

Rollback Post to Revision RollBack
_ForgeUser11973497
- Join Date: 8/3/2013
- Posts: 5
- Member Details
#7 _ForgeUser11973497

View User Profile

Send Message

Posted Aug 23, 2013
@TomShar

If you're having issues with the status file checking in the restart script, you can just remove this line on Windows:

IF NOT EXIST %STATE_FILE% EXIT

or these on Linux:

if [ ! -e $STATE_FILE ] then break fi

Rollback Post to Revision RollBack
_ForgeUser7774992
- Join Date: 10/28/2011
- Posts: 15
- Member Details
#6 _ForgeUser7774992

View User Profile

Send Message

Posted Aug 23, 2013
Some times the server doesn't boot back up but other times it does, any idea why?

Rollback Post to Revision RollBack
_ForgeUser11973497
- Join Date: 8/3/2013
- Posts: 5
- Member Details
#5 _ForgeUser11973497

View User Profile

Send Message

Posted Aug 9, 2013
Added an alternative config action format. /restart is broken for the time being.

Rollback Post to Revision RollBack
_ForgeUser11993345
- Join Date: 8/7/2013
- Posts: 1
- Member Details
#4 _ForgeUser11993345

View User Profile

Send Message

Posted Aug 6, 2013
Make a video about configuration please, it's a very useful plugin.

Rollback Post to Revision RollBack
_ForgeUser11973497
- Join Date: 8/3/2013
- Posts: 5
- Member Details
#3 _ForgeUser11973497

View User Profile

Send Message

Posted Aug 5, 2013
@snipershotmaster

You can rename the things to be a bit more readable... sorry about that. The names in the actions.* config nodes don't actually matter and can be named whatever. To disable sounds, simply remove the actions.sound_* nodes :)

Rollback Post to Revision RollBack
_ForgeUser11850874
- Join Date: 7/13/2013
- Posts: 177
- Member Details
#2 _ForgeUser11850874

View User Profile

Send Message

Posted Aug 5, 2013
It does work for windows for me but the config is a bit too complicated to use. Also how do i disable the sound?

Rollback Post to Revision RollBack
_ForgeUser11974298
- Join Date: 8/3/2013
- Posts: 44
- Member Details
#1 _ForgeUser11974298

View User Profile

Send Message

Posted Aug 5, 2013
typed /restart but my server didnt come bck online

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

63118
Created

Aug 4, 2013
Last Released File

Aug 5, 2013
Total Downloads

7,005
License

Simplified BSD License

Bukkit

ServerRestarter

Bukkit Plugins