RemoteBukkit
RemoteBukkit
Plugin v4.0.0 - GUI v2.0.0 - Console v2.0.0
General
RemoteBukkit allows admins to, with the help of a plugin, remotely use the server's console. You do this by running a client on you computer and you provide this client with the hostname and port on which the RemoteBukkit plugin's server is running. Of course you will also need to provide the client with the server's username and password (set up in the plugin config file) for security.
So, provided the server has the RemoteBukkit plugin installed, admins can remotely use the Bukkit Console to control the server and execute Bukkit console commands server side.
RemoteBukkit does support multiple, simultaneous, connected clients.
News
Major Plugin Update v4.0.0
The latest plugin release (v4.0.0) adds support for CB v1.7.2.
Major Plugin Update v3.0.0
The latest plugin release (v3.0.0) adds support for multiple users.
Minor Plugin Update v2.5.0
The latest plugin release (v2.5.0) adds a number of highly requested features as well as a fix for a critical exploit.
Use
Plugin
Simply place the plugin in the standard Bukkit plugin directory and it will automatically generate its configuration the next time the server is run. The config file format is very simple, but offers several flexible options. The defaults are:
port: 25564 verbose: true logsize: 500 users: - user: username pass: password
All avaliable options and their descriptions are listed below.
Option | Default | Description |
---|---|---|
port | 25564 | The port on which the RemoteBukkit server will listen (this MUST be different to the Bukkit server's port number) |
verbose | true | Whether or not RemoteBukkit will produce verbose logging information (in the form "client X dispatched command Y"). |
logsize | 500 | The maximum number of log lines to send to a client upon successful connection. |
users | (list) | A list of the users which are permitted to connect to the RemoteBukkit server. The syntax for defining multiple user entries can be found in the example below. |
A more complex example configuration file can be found below (for demonstration purposes).
port: 6001 verbose: false logsize: 12 users: - user: escortkeel pass: secretpassword - user: bukkitserver pass: thepassword - user: minecraft pass: server
GUI Client
RemoteBukkit offers a very simple and easy to use GUI client which you can use to connect to the plugin. Just double click on the GUI's jarfile to run it. The GUI features a self-explanatory interface where you supply the hostname, port, username and password of the RemoteBukkit server.
Run the GUI with no arguments to open the Login Dialog. Run the GUI with the following arguments and it will attempt to use the supplied parameters to login automatically:
Use: [hostname:port] [user] [pass]
Switches
--help
- Prints this help message.
Console Client
If you prefer to use a console-based application to connect to the RemoteBukkit plugin you can too! The console argument syntax is very simple but the program but will print help information if you supply no/the wrong number of/invalid arguments:
Use: [hostname:port] [user] [pass] <switches>
Switches
--help
- Prints the help message.--nolog
- Instructs the server not to send any log information to the client.--exec <command>
- Sends <command> to the server and then terminates. Useful for scripts. Make sure that you surround commands containing spaces in inverted commas (e.g. "say Hello, World!").
Telnet Client (advanced)
RemoteBukkit also supports telnet connections. Just connect to the normal server port as you would with the console or GUI clients and then supply the server's username and then password on separate lines, followed by a third, blank line.
e.g.
$ telnet [hostname:ip] [user] [pass] [blank line]
Download
The latest plugin build can be downloaded here.
The latest GUI build can be downloaded here.
The latest console build can be downloaded here.
Latest Changes
Plugin v3.0.0
- Added multi-user support!
GUI v2.0.0
- Updated protocol version
Console v2.0.0
- Added
--nolog
switch - Updated protocol version
Planned Features
A standalone GUICompleted!Integration with BukkitGUI - With the help of BertwareCompleted!- Integration with RunBukkit - Another GUI for Bukkit which is not on BukkitDev (yet!)
How Can I Help?
This plugin is developed solely by me in my free time so:
- If you are a developer would like to contribute to this project, or any of my other projects, please PM me or email me at [email protected].
- If you are a not developer but would still like to contribute somehow, please consider donating. Donations are highly valued and much appreciated.
About
Developer: Keeley Hoek (escortkeel)
@escortkeel
I now see it does, but not always.
at least that's how it was when I tested it just now.
@standsfield
500 is a HTTP response error code, meaning that you are not actually connecting to a RemoteBukkit-enabled server port. Instead, you are trying to connect to a web site.
@WhiteNightFury
Oh, I thought the GUI did that already. =/
I'll check that out in a sec.
@HomeDipo
Hmm. That is very strange. Did your color scheme go all non-areo and the see-through-ness disappeared?
@tjones965
Yes.
Can you make the GUI autoscroll when you scrolled to the bottom?
because now everytime something happens I have to scroll down -.-
telnet should work. it won't actually prompt you for the password, but if you type it in it will work.
>telnet (ip) (port)
username
password
(console here)
@escortkeel
Whenever I type something the GUI says " 500 command "[command]" not understood". How do I enter a command correctly? Thanks!
This is what I get:
Um the GUI just changed my color scheme. Any help?
Cheers.
Will this work with bukkit 1.3.2-r1.0?
RemoteBukkit + Dynmap = Total control over the server even when you're on the other side of the world. :)
I installed R: GUI v1.2.0 for CB 1.3.1-R1.0 and it was easy enough to configure, but this doesn't look like a GUI. It looks like a text console, black background with white text... Nothing that I would normally associate with a GUI, like a menu, groups of features in tabs or such-like.
Yes, port forwarding was set up to use a port separate from the Bukkit server and it does connect. It just displays scrolling text down what would easily be mistaken for a BASH-like shell terminal.
Is this the way it is intended to appear or is this a malfunction? Posted screenshots might give a user shopping for a remote tool a realistic expectation of what it was meant to look like.
I also have a concern that the username and password aren't salted. Will this be added?
@escortkeel
Im having the same problem someone else has had. It wont connect it says connection refused. I port-forwarded correctly, and all the data is right?
@xerobytez
Sorry about the absurd amount of time you've had to wait before you got a response from me! Sure, that sounds brilliant. :)
I'm like, super busy right now but I'll get right to it tomorrow afternoon (about this time tomorrow where I live).
Thanks,
Keeley :)
Excellent plugin escortkeel! I'm using your plugin to allow my website to send commands to my server, would you be able to add an option in the config.yml so when I connect it doesn't send the entire console history? As all I'm interested in is sending some commands. Thank you for your hard work!
@AssRealm
Please make sure that you are attempting to connect to your RemoteBukkit port and not your server's port. (And make sure that they are different).
@ZoRkCreativeCrafts
That command was never part of this plugin. Perhaps it is part of pail?
@escortkeel
Of course, it have always work until i update the server to 1.3.2
Now, it stay blockeed on "forcing save" It's anoying, because i can't stop the server with saving...
For now I'm using pail console plugin, i stop the server in it, and then kill java process before the wrapper make the server restart automaticly, but i'ld prefer use the good old .stopwrapper...
@escortkeel
For some reason, i typed in the login details, and when i click connect, it shows up a black screen.
Error before i try and connect,
6:24:32 PM [SEVERE] Exception in thread "Thread-13"
6:24:32 PM [SEVERE] java.lang.NullPointerException
6:24:32 PM [SEVERE] at me.escortkeel.remotebukkit.ConnectionListener.run(ConnectionListener.java:86)
@ZoRkCreativeCrafts
Did that ever work?