RemoteBukkit

Table of Contents

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 GUI~~ Completed!
~~Integration with BukkitGUI - With the help of Bertware~~ Completed!
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 escortkeel@live.com.
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)

Comments

_ForgeUser10333520
- Join Date: 1/5/2013
- Posts: 4
- Member Details
#197 _ForgeUser10333520

View User Profile

Send Message

Posted Jan 4, 2013
@coolo1

telnet hostname port

In my case this is as follows.

$ telnet 192.168.1.2 25564 Trying 192.168.1.2... Connected to gandalf. Escape character is '^]'. username password 192.168.1.10:56269 connected to RemoteBukkit!
Rollback Post to Revision RollBack

_ForgeUser10333520

Join Date: 1/5/2013
Posts: 4
Member Details

#196 Posted Jan 4, 2013

I'm trying to use the remote console to issue a simple list command as a test before I start anything else. When I use it I only get the help message. Also I tried netcat (nc) but I get an error after getting the console history dump.

Here are my attempts at commands. Please help me find my mistake.

$ java -jar RemoteBukkitConsole-1.3.2.jar 192.168.1.2 username password list
Launching RemoteBukkit Console Client v1.3.2!

By Keeley Hoek (escortkeel)

Invalid Switch: list
Use: [hostname:ip] [user] [pass] <swithches>

Switches:
--help       Prints this help message.
--pefixlevel Prefixes each output message with the log level.

$ echo -e "username\npassword\nlist\n" | nc -C 192.168.1.2 25564
192.168.1.10:55421 connected to RemoteBukkit!
06:22 PM [INFO] [PasswordProtect] Enabling PasswordProtect v1.1.3
06:22 PM [INFO] PasswordProtect 1.1.3 is enabled!
06:22 PM [INFO] [Multiverse-Core] Enabling Multiverse-Core v2.5-b641
06:22 PM [INFO] [AllPay] - Version 10.0 - using only an item based economy for Multiverse-Core v2.5-b641
06:22 PM [INFO] Preparing start region for level 3 (Seed: -5463115312346591597)
06:22 PM [INFO] Preparing spawn area for creative, 52%
06:22 PM [INFO] Preparing start region for level 4 (Seed: -6244440654929154117)
06:22 PM [INFO] Preparing spawn area for my_world, 48%
06:22 PM [INFO] [Multiverse-Core] 5 - World(s) loaded.
06:22 PM [INFO] [Multiverse-Core] Version 2.5-b641 (API v18) Enabled - By Rigby, fernferret, lithium3141 and main--
06:22 PM [INFO] [Multiverse-Portals] Enabling Multiverse-Portals v2.4-b548
06:22 PM [INFO] [Multiverse-Portals] - Version 2.4-b548 Enabled - By Rigby and fernferret
06:22 PM [INFO] [Multiverse-Portals]  0 - Portals(s) loaded
06:22 PM [INFO] [MobArena] Enabling MobArena v0.94.4.90
06:22 PM [WARNING] [MobArena] Vault was not found. Economy rewards will not work!
06:22 PM [INFO] [MobArena] v0.94.4.90 enabled.
06:22 PM [INFO] [Carz] Enabling Carz v2.1
06:22 PM [INFO] [Carz] Enabled!
06:22 PM [INFO] [KeepItems] Enabling KeepItems v1.0.rc2
06:22 PM [INFO] [Multiverse-NetherPortals] Enabling Multiverse-NetherPortals v2.4-b530
06:22 PM [INFO] [MultiVerse-NetherPortals] - Version 2.4-b530 Enabled - By Rigby and fernferret
06:22 PM [INFO] Server permissions file permissions.yml is empty, ignoring it
06:22 PM [INFO] Done (14.570s)! For help, type "help" or "?"
06:22 PM [INFO] [WirelessRedstone] A new update has been released ! You can download it at http://dev.bukkit.org/server-mods/wireless-redstone/
06:23 PM [INFO] There are 0/20 players online:

06:39 PM [INFO] Unknown command. Type "help" for help.
06:39 PM [INFO] Unknown command. Type "help" for help.
06:39 PM [INFO] There are 0/20 players online:

RemoteBukkit closing connection for reason:

Socket Read Error!

_ForgeUser7430002
- Join Date: 8/22/2011
- Posts: 209
- Member Details
#195 _ForgeUser7430002

View User Profile

Send Message

Posted Jan 4, 2013
@escortkeel

So... Will it be in an update?

Rollback Post to Revision RollBack
_ForgeUser8413476
- Join Date: 2/12/2012
- Posts: 261
- Member Details
#194 _ForgeUser8413476

View User Profile

Send Message

Posted Jan 3, 2013
@escortkeel

I used the GUI version of RemoteBukkit. I didn't need to scroll every time but if I scrolled to the top one time and down again it stopped auto-scrolling. But now I am using the console client because it brings the 'byobu feeling' back.

A simple question: I am using CommandHelper for my Spleef, PVP an a few other plugins. CommandHelper brings a simple API to create own plugins if you are not 'speaking' java. But the commands you create with that are not actually bukkit commands, they are called 'aliases'. I'm only able to run these aliases by typing runalias /aliasname parameters. When I used the linux/gnome terminal I did not have to do this. Furthermore the console() output of CommandHelper does not work what's not a problem because I can use sys_out instead.

Thank :)

Rollback Post to Revision RollBack
escortkeel
- Location: Canberra
- Join Date: 9/19/2011
- Posts: 291
- Member Details
#193 escortkeel

View User Profile

Send Message

Posted Jan 1, 2013
@UbuntuFreak

To my knowledge it is meant to do that already, so what you are reporting appears to be a bug. Under exactly what circumstances does the "not-scrolling" occur?

Thanks!

Rollback Post to Revision RollBack
escortkeel
- Location: Canberra
- Join Date: 9/19/2011
- Posts: 291
- Member Details
#192 escortkeel

View User Profile

Send Message

Posted Jan 1, 2013
@DanH42

I have actually made a custom build which does that already, and I was ready to make an official release for it, but the tester never got back to me. You can find that conversation here.

Feel free to test it yourself and if it works, I'll put out an official plugin release 1.6.0. :D

Rollback Post to Revision RollBack
escortkeel
- Location: Canberra
- Join Date: 9/19/2011
- Posts: 291
- Member Details
#191 escortkeel

View User Profile

Send Message

Posted Jan 1, 2013
@coolo1

Sorry, I though that I added that... I'll do it again now.

Rollback Post to Revision RollBack
escortkeel
- Location: Canberra
- Join Date: 9/19/2011
- Posts: 291
- Member Details
#190 escortkeel

View User Profile

Send Message

Posted Jan 1, 2013
@edragy

GitHub!

Last edited by escortkeel: Jan 1, 2013

Rollback Post to Revision RollBack
_ForgeUser8413476
- Join Date: 2/12/2012
- Posts: 261
- Member Details
#189 _ForgeUser8413476

View User Profile

Send Message

Posted Dec 26, 2012
Really good plugin! I love it :) But please make a function that scrolls to the end of the page when new text is coming. I always have to do that by hand

Rollback Post to Revision RollBack
_ForgeUser7819417
- Join Date: 11/6/2011
- Posts: 3
- Member Details
#188 _ForgeUser7819417

View User Profile

Send Message

Posted Dec 15, 2012
I'd like to be able to tell this plugin to bind only to localhost, so it's not accessible from outside the server. Could you add a configuration line that lets you run RemoteBukkit on an IP other than the one Bukkit runs on?

Rollback Post to Revision RollBack
_ForgeUser7430002
- Join Date: 8/22/2011
- Posts: 209
- Member Details
#187 _ForgeUser7430002

View User Profile

Send Message

Posted Dec 11, 2012
How would I connect via telnet from a telnet client?

Rollback Post to Revision RollBack
_ForgeUser9248767
- Join Date: 7/18/2012
- Posts: 25
- Member Details
#186 _ForgeUser9248767

View User Profile

Send Message

Posted Dec 9, 2012
Is the source of the plugin available?

Rollback Post to Revision RollBack
escortkeel
- Location: Canberra
- Join Date: 9/19/2011
- Posts: 291
- Member Details
#185 escortkeel

View User Profile

Send Message

Posted Dec 7, 2012
@WhiteNightFury

I'll have a look right now.

Rollback Post to Revision RollBack
escortkeel
- Location: Canberra
- Join Date: 9/19/2011
- Posts: 291
- Member Details
#184 escortkeel

View User Profile

Send Message

Posted Dec 7, 2012
@wesley01999

In the works. :)

Rollback Post to Revision RollBack
escortkeel
- Location: Canberra
- Join Date: 9/19/2011
- Posts: 291
- Member Details
#183 escortkeel

View User Profile

Send Message

Posted Dec 7, 2012
@destym

Sure!

EDIT: Done!

Last edited by escortkeel: Dec 7, 2012

Rollback Post to Revision RollBack
escortkeel
- Location: Canberra
- Join Date: 9/19/2011
- Posts: 291
- Member Details
#182 escortkeel

View User Profile

Send Message

Posted Dec 7, 2012
@LeeTheENTP

The current version works with 1.4.2. :)

P.S. Thanks for the question, you prompted me to update the file metadata.

Last edited by escortkeel: Dec 7, 2012

Rollback Post to Revision RollBack
_ForgeUser7014860
- Join Date: 6/14/2011
- Posts: 82
- Member Details
#181 _ForgeUser7014860

View User Profile

Send Message

Posted Dec 1, 2012
When Im trying to connect, it shows up -

Connection to server lost Software caused connection abort: recv failed

Rollback Post to Revision RollBack
LeeNeighoff
- Location: Maryland
- Join Date: 8/9/2012
- Posts: 267
- Member Details
#180 LeeNeighoff

View User Profile

Send Message

Posted Nov 3, 2012
When do you think you'll have a 1.4.2-compatible version out, if the current version doesn't already work with 1.4.2?

Rollback Post to Revision RollBack
_ForgeUser7651665
- Join Date: 10/4/2011
- Posts: 5
- Member Details
#179 _ForgeUser7651665

View User Profile

Send Message

Posted Nov 1, 2012
Thanks for a great plugin. Convenience suggestion... Treat all input that starts with "/" as commands, otherwise prepend the input with "say ", so that the app can be used for easy chat from console. Takes 5 minutes to implement, saves tons of effort later. :]

Rollback Post to Revision RollBack
_ForgeUser8952937
- Join Date: 5/28/2012
- Posts: 9
- Member Details
#178 _ForgeUser8952937

View User Profile

Send Message

Posted Oct 30, 2012
A suggestion

You should make a web login website so you can login from a website and an Android & iOS app so you can login from almost any where because when im out and about and want to check my console and i can unless i were to lug my laptop around

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

35612
Created

Jan 13, 2012
Last Released File

Feb 11, 2014
Total Downloads

69,200
License

Simplified BSD License

Bukkit

RemoteBukkit

Bukkit Plugins

RemoteBukkit

Table of Contents

RemoteBukkit

General

News

Major Plugin Update v4.0.0

Major Plugin Update v3.0.0

Minor Plugin Update v2.5.0

Use

Plugin

GUI Client

Console Client

Telnet Client (advanced)

Download

Latest Changes

Plugin v3.0.0

GUI v2.0.0

Console v2.0.0

Planned Features

How Can I Help?

About

Comments

About This Project

Categories

Members

Recent Files

Bukkit