Application RemoteToolkit - Restarts + crash detection + auto saves + remote console!

Minecraft RemoteToolkit
-Less downtime, more fun for your players, more power to you!​

Are you a Minecraft server administrator? Do you value up-time and stability? Do you fancy the ability to remotely control your server, both in-game and out of game, in a myriad of useful ways from a plethora of different devices?
If you answered yes to any of the above, then the Minecraft RemoteToolkit is for you!

What the Minecraft RemoteToolkit Plugin and Wrapper do for you:

• Provides almost perfect server uptime with no need for action from an owner/administrator!
• Have your server save and restart at any time period with configurable restart warnings!
• The Toolkit guarantees a restart within the set restart period, even if your server crashes, becomes unresponsive, or encounters a "SEVERE" exception!
• Remotely control every function of the Toolkit, even from your smart phone!
• Full remote console access via telnet with support for multiple terminal types!
• Telnet daemon conforms to current Telnet related RFCs!
• Customizable alert messages!
• Fully extendable though 3rd party modules!
• Full feature set works with most craftbukkit builds!
• Most features work with any Minecraft server variation, even vanilla!
• Telnet can be disabled!

For server administrators
Download - Release 10, Alpha 15.3 [CB 1.7.2-R0.2] (wget friendly)
Instructions & Documentation​

For developers
UDP API REV 8 | Documentation
Module API | Coming soon!​

For everyone
Official IRC channel
#remotetoolkit @ irc.esper.net​

"Help! I've downloaded it, but I do not know how to get it working!"​

Stop! Before you give up or ask for help, make sure you have read the step-by-step installation instructions on the wiki page. If you are still having problems, please do not be hesitant to post a request for help on this thread or in the IRC channel - no matter how simple your problem seems.​

Changelog
Release 10, Alpha 15
Release 10, Alpha 14
Release 10, Alpha 13
Release 10, Alpha 12
Release 10, Alpha 11
Release 10, Alpha 10
Release 10, Alpha 9
Release 10, Alpha 8
Release 10, Alpha 7
Release 10, Alpha 6
Release 10, Alpha 5
Release 10, Alpha 4
Release 10, Alpha 3
Release 10, Alpha 2
Release 10, Alpha 1​

Todo​

Any donation would be very much appreciated. I'm but a poor University student, and I sacrifice quite a lot of unpaid time to keep the Toolkit updates and support flowing.​

Thank you to the following who have chosen to support the Toolkit through a donation:
Deren909, marshall007, Vittek, clanslots, meee, KyneSilverhide, szoller, hungoverfurball, Lama_0, Viet, acc1dent, joby890, Liger_XT5​

 

Can I run the plugin like any other plugin?

 

My god it worked! Thank you sir

 

In wrapper.properties, set extra-runtime-arguments to:

Code:

extra-runtime-arguments=-Djline.terminal=jline.UnsupportedTerminal,-server,-XX:+CMSIncrementalPacing,-XX:PermSize=128m,-XX:LargePageSizeInBytes=4m,-XX:MaxPermSize=128m,-XX:+DisableExplicitGC,-XX:+UseConcMarkSweepGC,-XX:+UseParNewGC,-XX:+CMSParallelRemarkEnabled,-XX:MaxGCPauseMillis=500,-XX:ParallelGCThreads=8,-XX:+UseAdaptiveGCBoundary,-XX:-UseGCOverheadLimit,-XX:+UseBiasedLocking,-XX:SurvivorRatio=16,-XX:TargetSurvivorRatio=90,-XX:MaxTenuringThreshold=15,-Xnoclassgc,-XX:UseSSE=3,-XX:+UseLargePages,-XX:+OptimizeStringConcat,-XX:+UseFastAccessorMethods,-XX:+AggressiveOpts,-Xincgc

I have been able to replicate the issue with the misprinted color control characters, and will look into having them fixed. If no efficient fix can be done, I will implement an alternative GUI for windows users that should fix all of these problems, should you choose to use it.

I'm currently reinvestigating the issue.

No, you will need to install the included wrapper for it to work correctly. Please see the wiki for instructions on how to install the wrapper.

 

I got this error when restarting my server from windows 7 using version R10 Alpha 10.31.
It just happened once though. I can not recreate the error myself now when I try...

Code:

Restarting server...
20:20:44 [INFO] Stopping server
java.io.IOException: Stream Closed
        at java.io.FileInputStream.readBytes(Native Method)
        at java.io.FileInputStream.read(FileInputStream.java:236)
        at sun.nio.cs.StreamDecoder.readBytes(StreamDecoder.java:282)
        at sun.nio.cs.StreamDecoder.implRead(StreamDecoder.java:324)
        at sun.nio.cs.StreamDecoder.read(StreamDecoder.java:176)
        at java.io.InputStreamReader.read(InputStreamReader.java:184)
        at java.io.BufferedReader.fill(BufferedReader.java:153)
        at java.io.BufferedReader.read(BufferedReader.java:174)
        at com.drdanick.McRKit.Wrapper$3.run(Wrapper.java:402)
Restarting...

This plugin is awesome!
Though: The usernames are case sensitive in this plugin. They should not be. They should be case insensitive.

Also you should open source this project so others can help you.
Please put it on github

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

Odd, that exception should have been suppressed. It occurs normally when the stdout/stderr streams of the minecraft server process close on a restart/stop. Feel free to ignore it.

Good point, I will issue a fix for that in release 11.

On the point of open sourcing the project, release 11 is planned to be the first open source release. And yes, it will be on github.

 

Hell yeah! \/
This is an awesome project by the way. Automatic restarts is very important for my server to work as it has memory leaks so i felt like this when I found this plugin:

 

My server runs linux. This worked on my test server (windows), however, when I put it on the linux server, it stopped working, saying org.bukkit.craftbukkit.Main was unknown or something. I used the SH that starts Minecraft_Rkit.jar. Using the same wrapper.properties.

What do I need to change to make it work on linux? Is this supposed to happen?

Thank you so much

 

Not possible to put out an ETA is it?

 

Will this work with any remote udp client?

 

Just curious... are frequent PermGen Errors after several restarts common? I have this problem, but this plugin is my solution. My admins love it too. My players will just text them if they are not on, and they can access the panel from their phones. Thanks for this awesome tool

 

how would i get this working with McMyAdmin?
@drdanick

 

Hi
Awesome plugin, helps me a lot, but since yesterday I got this error after a while:

Code:

[ERROR] IOException writing to the console: java.io.IOException: Stream Closed
java.io.IOException: Stream Closed
        at java.io.FileOutputStream.writeBytes(Native Method)
        at java.io.FileOutputStream.write(FileOutputStream.java:297)
        at java.io.BufferedOutputStream.flushBuffer(BufferedOutputStream.java:82)
        at java.io.BufferedOutputStream.flush(BufferedOutputStream.java:140)
        at com.drdanick.McRKit.Wrapper.handleScheduledEvent(Wrapper.java:952)
        at com.drdanick.McRKit.Scheduler.fireScheduledEvent(Scheduler.java:283)
        at com.drdanick.McRKit.Scheduler.access$000(Scheduler.java:13)
        at com.drdanick.McRKit.Scheduler$2.run(Scheduler.java:174)
        at java.util.TimerThread.mainLoop(Timer.java:534)
        at java.util.TimerThread.run(Timer.java:484)

RB: 953
Plugins: AuthDB, Citizens, Controllerblock, CoorTeleport, DataLog, General, MultiInv, MultiVerse, NoMoreRain, Permissions 2.7, PistonChest(The error appeared after adding this plugin, maybe it's because of it), WorldEdit, iChat, iConomy, mcMMO, Runcraft.


Nothing special happens before this error appears. It appeared after a while, something between 30 minutes and an hour. Hope you know something to fix this. Here are the configs:

Code:

#Minecraft Remote Toolkit Properties File
#Fri Jul 08 21:44:41 CEST 2011
forced-restart-delay=5m
maximum-heap-size=3000M
toolkit-autoshutdown-alerts=10m,5m,1m
restart-on-severe-exception=true
server-saveall-period=0
extra-runtime-arguments=-Djline.terminal\=jline.UnsupportedTerminal,-XX:ParallelGCThreads=16,-server,-Xincgc,-XX:+UseConcMarkSweepGC,-XX:+CMSIncrementalPacing,-XX:+AggressiveOpts,-XX:+CMSParallelRemarkEnabled,-XX:+DisableExplicitGC,-XX:MaxGCPauseMillis=400,-XX:SurvivorRatio=16,-XX:TargetSurvivorRatio=90,-XX:+UseAdaptiveGCBoundary,-XX:-UseGCOverheadLimit,-Xnoclassgc,-XX:UseSSE=3,-XX:PermSize=300m,-XX:LargePageSizeInBytes=16m
force-save-on-restart=true
server-heartbeat-threshold=1m
server-restart-alerts=10m,5m,1m
minecraft-server-jar=craftbukkit.jar
initial-heap-size=3000M
overridden-process-arguments=
failed-heartbeat-restart-count=5
severe-exception-detection-level=1
server-arguments=nogui
toolkit-autoshutdown-delay=0
import-properties=false
server-restart-delay=2h

 

Im trying to add a new user/first user. But when I type in .useradd bob bob I just get a unknown console command. Im using Craftbukkit and have the MinecraftRKitPlugin.jar in the plugins folder, Were using the latest craftbukkit and the latest remotetoolkit. I have tried this on both the main linux box and my personnal windows 7 box but I get the unknown command error both times.

 

15:56:31 [INFO] This server is running Craftbukkit version git-Bukkit-0.0.0-904-g9277096-b953jnks (MC: 1.7.2)
15:56:35 [SEVERE] Could not load 'plugins/Minecraft_RKit.jar' in folder 'plugins':
java.io.FileNotFoundException: Jar does not contain plugin.yml
at org.bukkit.plugin.java.JavaPluginLoader.loadPlugin(JavaPluginLoader.java:64)
at org.bukkit.plugin.SimplePluginManager.loadPlugin(SimplePluginManager.java:199)
at org.bukkit.plugin.SimplePluginManager.loadPlugins(SimplePluginManager.java:122)
at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:118)
at org.bukkit.craftbukkit.CraftServer.<init>(CraftServer.java:89)
at net.minecraft.server.ServerConfigurationManager.<init>(ServerConfigurationManager.java:51)
at net.minecraft.server.MinecraftServer.init(MinecraftServer.java:132)
at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:335)
at net.minecraft.server.ThreadServerApplication.run(SourceFile:422)

I get this error when I start the server, Can anyone help? Thanks.

 

How are you launching your linux server exactly? Try launching Minecraft_Rkit.jar from inside the directory it's located. Also, can you give me the console output of the error?

Within the month, hopefully.

It will work with any UDP client that can send arbitrary packets. Feel free to ask if you need any assistance with the packet format.

I am not sure I could recommend having the server behind two wrappers. But, if you want to try, there are two options: either have the Toolkit launch McMyAdmin (McMyAdmin will launch the minecraft server), or, have McMyAdmin launch the Toolkit (the Toolkit will launch the minecraft server).
This completely depends on what you wish to use the toolkit for, and what you wish to use McMyAdmin for.

On a side note, if you are looking for a free panel that supports the Toolkit, try out milkAdmin.

That error is being caused by a heartbeat request being sent to the server when the input stream to the server has become broken. Did this error occur repeatedly, or only once?

You are likely not using the wrapper component. See the wiki page on how to set the wrapper up. Feel free to ask if you have any problems with setting it up.

You are trying to use the wrapper jar as a bukkit plugin. Make sure you read the wiki page on how to set the wrapper component up. Feel free to ask if you have any problems setting it up.

 

@drdanick
this error happens often, sadly. I lowered the restart time to 1h to prevent this, it seems to happen when the server runs a long time. My usual restart time was 2h. But now it happened again an hour ago.

 

You have to unzip all files and put them into the server directory. Not only the .jar file

 

When the error does occur, does it happen once, or start repeating every minute?

 

@drdanick
It starts repeating every minute or so. Can't say how often exactly because it's not logged.

 

Odd. Can you try typing a few arbitrary bukkit commands into the console after the error is printed? If bukkit recognizes the commands, then it's definitely an issue on my end.

 

@drdanick
I tried it out, and it doesn't work. If I type anything, it says something like "Trying to reopen Stream", but then nothing happens anymore. Thanks for helping me

 

Yeah, the input stream to the server has become closed. There is nothing on the toolkits end that does this. Double check the plugins you have installed. There is a possibility that a plugin has triggered this.

 

@drdanick
Ok, thx alot

 

How I'm going to start the .sh file in my VPS?

 

I did what you said and this still happens. Is there something else im doing wrong?

Code:

Minecraft Remote Toolkit R10 Alpha 10.31
Initializing...
Loading toolkit properties...Done.
Loading toolkit modules...ERROR: Could not load Toolkit Module toolkit/modules/Minecraft_RKit.jar in toolkit/modules: null
Done.
Wrapper is running on: Linux 2.6.38-8-generic amd64
Starting wrapper...
Starting UDP listen server on port 25561
Jul 18, 2011 1:26:17 PM net.wimpi.telnetd.net.PortListener run
INFO: Listening to Port 25,561 with a connectivity queue size of 5.
151 recipes16 achievements13:26:18 [INFO] Starting minecraft server version Beta 1.7.2
13:26:18 [INFO] Loading properties
13:26:18 [INFO] Starting Minecraft server on *:25565
13:26:18 [INFO] This server is running Craftbukkit version git-Bukkit-0.0.0-904-g9277096-b953jnks (MC: 1.7.2)
13:26:21 [SEVERE] Could not load 'plugins/Minecraft_RKit.jar' in folder 'plugins':
java.io.FileNotFoundException: Jar does not contain plugin.yml
    at org.bukkit.plugin.java.JavaPluginLoader.loadPlugin(JavaPluginLoader.java:64)
    at org.bukkit.plugin.SimplePluginManager.loadPlugin(SimplePluginManager.java:199)
    at org.bukkit.plugin.SimplePluginManager.loadPlugins(SimplePluginManager.java:122)
    at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:118)
    at org.bukkit.craftbukkit.CraftServer.<init>(CraftServer.java:89)
    at net.minecraft.server.ServerConfigurationManager.<init>(ServerConfigurationManager.java:51)
    at net.minecraft.server.MinecraftServer.init(MinecraftServer.java:132)
    at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:335)
    at net.minecraft.server.ThreadServerApplication.run(SourceFile:422)
13:26:22 [SEVERE] ebean.properties not found
13:26:22 [INFO] DataSourcePool [SimpleAdmin] autoCommit[false] transIsolation[SERIALIZABLE] min[2] max[20]
13:26:23 [INFO] SubClassFactory parent ClassLoader [org.bukkit.plugin.java.PluginClassLoader]

 

Remove Minecraft_Rkit.jar from both the plugins/ directory and the toolkit/modules/ directory.

 

@drdanick

Any chance of getting up-arrow history support and preventing the output from overwriting the input line? (both features are in bukkit, but are disabled through the wrapper).

 

Hallo
I've been a happy user of RT for months now, but as of RB1000 my console faithfully reproduces white text from chat as a very very pale gray on the white console. This is "fixable" by using iChat to make chat text black, but obviously that's not a real solution. Is there a way to discard color codes? It's super-unreadable at the moment

Thank you!

 

Oh btw, on every version of this wrapper since Minecraft 1.5 (maybe 1.6), the server just stops working after about an hour and it spams the console with "[INFO] Read timed out." messages. .stopwrapper, .restart, stop, etc. don't work. I have to kill it manually.

Fyi, I have a CentOS OpenVZ VPS, and I modified the startup script a bit to have a -20 nice and screen (for Putty).

I've just been using some version of this wrapper from Minecraft 1.4 for the past few months, no problems. Here's my config:

Code:

#Minecraft Remote Toolkit Properties File
#Fri Apr 29 21:31:07 PDT 2011
minecraft-server-jar=craftbukkit.jar
severe-exception-detection-level=2
server-saveall-period=10m
maximum-heap-size=2048M
import-properties=false
server-restart-delay=4h
server-heartbeat-threshold=30s
restart-on-severe-exception=true
server-arguments=nogui
overridden-process-arguments=nice -n -20 java -Xms1024M -Xmx2048M -Djline.terminal\=jline.UnsupportedTerminal -jar craftbukkit.jar nogui
failed-heartbeat-restart-count=10
server-restart-alerts=10m,5m,1m
forced-restart-delay=5m
initial-heap-size=1024M
extra-runtime-arguments=-Djline.terminal\=jline.UnsupportedTerminal

If you need more info, just ask. Idk if this is a problem with your wrapper or my VPS, but I thought I would tell you. I probably should have posted this earlier tbh.

And yes, I updated both the wrapper AND the plugin AND the other files, several times over the past couple months. Every time, I got the "[INFO] Read timed out" errors and a server crash.

In the terminal, cd to the correct directory and type "bash startserver.sh".

 

Eventually. This is not a simple task, but I plan on doing it.

What operating system are you using? You should be able to change the background and default text colour of your terminal quite simply. I am reluctant to write algorithms to strip the colour codes out, as this adds unnecessary overhead. Bukkit should not force non-standard console behaviour upon users in the first place, and they are likely to add a flag to remove this behaviour in the near future, much like they did with jline.

The next time this happens, can you connect to the console via telnet and attempt a .restart from there? I'm curious to know if that works. It's a little worrying that this particular problem (on bukkit's end) is stopping the wrapper from interpreting wrapper-specific commands.