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)
@4am
RemoteBukkit uses a custom, generic, authenticated socket connection to send and receive data. RemoteBukkit supports multiple, independent, simultaneously connected clients.
You can now find the source on GitHub
@ferrybig
I'll have to ask you to take a look at Bertware's BukkitGUI for player and plugin lists.
@eriorkless
Because I don't have access to the BukkitGUI source code, I can't help you with that one. You'll have to ask Bertware.
Hello, I'm trying to run this with Bertware's Bukkit gui but whenever I go to the superstart tab to see if the remote is working, everything's grayed out. Can you help?
Thanks, eriorkless
I also made an kind of remote connection for bukkit for my private server, doas this plugin have an player and plugin list ad the clinet side?
What kind of connection does this make, is it Telnet, SSH, RCON? Does it allow for multiple independent console instances?
EDIT: I see that your license states that this plugin project is released under the GPLv3, however I cannot find any source code link (GitHub only contains JAR files). Is the source in the JARs? It would be nice of you to commit the actual source code to GitHub so the project can be inspected/forked.
@Acren
Hi Acren,
Sorry it has taken me so long to respond!
Example syntax for RemoteBukkit console would be:
RemoteBukkitConsole.jar play.myserver.net:25564 username password
where
play.myserver.net
is the server address,25564
is the port that the plugin is listening on (not the port that the server is listening on) andusername
andpassword
is the correct username and password pair (configured in the plugin file).Hopefully I've helped in explaining how to use the console interface but if you have any other questions please feel free to ask!
Thanks,
Keeley :)
I'm pretty much an end-user (very little java experience) and I'm interested in trying this out, however I can't seem to get the syntax right in command prompt to run this. No matter what I try it says my argument syntax is invalid. Could you please give me an example of the syntax to run this? Thanks.
@Anonymistro
Gencode is correct. The plugin just allows you to use the server console without Bukkit having to run on your own machine. Soon a GUI interface will be released, and RemoteBukkit has already been integrated with BukkitGUI, a Bukkit Server GUI.
Enjoy,
Keeley Hoek :)
@Anonymistro
From what I've read, this only gives access to the console of the server, nothing more. And the username/password is specific to this addon only.
Kinda' sketchy about this plug-in for many reasons.. My main concern is a Bukkit plug-in allowing access to the host's server.jar file? Not so safe about distributing my server password or username info either - As I'm sure many would like to keep that as confidential as possible; if at all possible.
Nothing against you or your plug-in, but maybe I feel it's best to just wait until Bukkit updates it all themselves rather than relying on this.
Regardless, I'll make an attempt to initiate the plug-in and report back any errors for some troubleshooting!