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)
No this is my issue. When i hit connect, the GUI console says server closed connection every single time. I have even tried it on other computers.
Could someone PM me if they could help me or if they have had this problem and fixed it.
@supermegacraft14
Hi again!
So basically, my previous response means that you have to choose a different port for the RemoteBukkit plugin than the server's port. Try using the default port of 25564.
~
Keeley@escortkeel
it still wont work when i try to connect to it with the GUI when i click connect it says server closed connection still
@Preatomicmatt
Have to sleep now, its really late over here. :(
Hopefully I'll be able to get back to you further in the morning.
~
Keeley@Preatomicmatt
EDIT: I just saw you new response :D. You do need to port forward the port to the server/plugin, but not on the client-side. My previous response is listed below. Enjoy! :)
Hi Preatomicmatt!
That error simply means that the GUI failed to connect to RemoteBukkit's plugin. There is a whole host of reasons why this could be, but the most common cause is that the server is not running and/or the plugin is not installed properly.
Please verify that the server is running on the host that you specified and also verify that, by checking you console logs for the following text, that the plugin is running:
Also check that the port specified is correct.
If you don't know how to do any of these things or you have tried them all, without success, feel free to ask for clarification/more help. I'd me more than happy to continue with support! :D
Thanks,
Keeley :)
@Escortkeel Do I have to port-forward? Look at my comment below to see my issue. Thanks for your time. :D
@supermegacraft14
Hi supermegacraft14!
Only one application at a time can "bind" itself to a port.
To get around this, RemoteBukkit uses a different port to the main Bukkit server (by default 25564).
Hope I've helped,
Keeley :D
hello, I'm having a real issue here, when i type in my user, pass, and port into the plugin wont work. Ill type in my user and pass with port 25564 and it works, but the plugin wont work if i use my actual port 25565. Even if i use any of those the GUI v1.2.2 when i type in my user, pass, port, and host it says "server closed connection" then it shuts down. Then on my actual console it says (my ip) and then 'lost connection'. I have been trying different things for about an hour now and I've re-downloaded it a few times and it still wont work. Could someone please help me?
Hello, when I enter in all the correct information, it says "Failed to connect to server", "Connection refused: Connect"
Good plugin for VPS server!
@rogermao
Hi rogermao! :D
Yeah, so ummh, you can just "double-click" the GUI client to open and run it. However, if you'd like to run it from you operating system's terminal equivalent, use:
Or, if you'd like the GUI to automatically log in (so you could run the GUI with a .bat file, etc. without having to type in the parameters each time) you can use:
The console client is a bit different because it doesn't have a GUI so you have to run it like this:
Or, if you need help, just do:
And that's it!
If you need any more help feel free to ask,
Keeley :D
Hey, sorry this is probably a dumb question, but how do I run the GUI/Console Clients? I tried just opening the .jar file with java.exe, but then this popped up
Could not find the Main class: path to the jar file Program will now exit
@Colinz25
No problem!
@escortkeel
Thank you!! All of us are very happy now! Keep up the great work on this amazing plugin! :)
@Colinz25
Yeah, I've just found a bug where if the the Socket listener times out (because no-one has been connecting for ages) it will close and won't listen for any more connections. That's fixed in Plugin v1.2.2! :D
Thanks for the bug report!
~
Keeley@Colinz25
Hey Colinz25!
I'll have a look to see if I can find the problem, I have some ideas! :D
~
KeeleyHey there! I'm having a problem that I've noticed for a while now.
After several hours (unsure of an exact number), my console and GUI are unable to connect to the server. I'll get "Connection refused: connect" from the console and "Failed to connect to server: Connection timed out: connect" from the GUI. Both of these are able to connect immediately after server startup, and a few hours afterwards. But a few more hours go by and I notice that I (and my other admins) are unable to connect to RemoteConsole. Any help? Thanks!
@wouter93
Nvm figured out :D
"%ProgramFiles%\Java\jre7\bin\java.exe" -jar RemoteBukkitGUI-1.1.2.jar 127.0.0.1:25564 user password
I don't understand how to add arguments
Use: [hostname:ip] [user] [pass] <switches>
@dxwarlock
Thanks dxwarlock! Thanks for supporting for the project! :D
If you have an suggerstions or feature requests that will make the project better, feel free to ask!
~
Keeley