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)
@darkerarceus
Thanks Duy! :)
Hey Keelster! You've got a typo in your overview, you spelt prefix wrong in your switches!
-Fruity / Duy
Hi, with last version, the ".stopwrapper" command doesn't want to save and stop the server, any ideas?
Love this plugin...
@Mazgula
No problem maz! :)
@escortkeel
Greetings! Still lovin' it! Can you make the text scroll properly in the GUI? It gets hung up if I don't have the window focused. If this is intentional, perhaps add a idle/break line instead of the stopscroll ala mIRC?
Thanks Maz
@werner291
You can just kill the process. ;) When the client receives a SIGTERM signal, it will close the socket gracefully before exiting. :)
Hi, I'm trying to write an auto-backup bash script using your plugin. It seems to work properly, but how do I stop the command line program after starting it (without simply killing the process)?
@Miffedgrunt
Please verify that the file you downloaded is not corrupted.
hi, i got a error saying that the plugin.yml was not in the .jar :/
@SirKnightGMashburn
np. ;)
@escortkeel
Okay, I caught my mistake. I mistyped when forwarding the port and put 22564. Thank you for your help. ^-^
@SirKnightGMashburn
Hi! :D
Yeah, I'll get right to answering your question! You are going to want to forward the port that remotebukkit is listening on (so in your case it looks like 25564).
More generally, that error message means that the IP address was valid but when the GUI client asked the server if it could connect to port 25564, the server refused because:
OR
OR
OR
Hope I've helped,
Keeley :)
This is what I, or any other admin on our server, gets every time. Do we have to forward a specific port for this to work? Make an exception in the firewall? It works whenever I use localhost for the host, but when I put in the server IP this is what we get.
inb4 is the server turned on. Yes, it is. Always is. (so much hormones ._.)
Yes, It's updated to Craftbukkit 1.3.1.
hey i just wanted to ask a question can someone start the server and stop it without me running the original server.command ?
thanx love to hear from u soon
@Mayhem777
Yep! :D
Last ver also works with 1.2.5? thanks!
@Mazgula
Try now. ;)
@Mazgula
Oh, that's a problem! One-second... (I'll fix it)
@escortkeel
Heya Mr. Keel I get an error upon opening the new GUI,
"Failed to load Main-Class manifest attribute from C:\Users\User\Desktop\RemoteBukkitGUI-1.2.0.jar"
D:
@MathijsNL
No problem. ;)