WebSocketServices

This plug-in is an ongoing and evolving project with the intent to bring web support, through websockets, to the Minecraft bukkit servers. This implementation of websockets is designed to be light-weight and simple, reducing overhead to the game server itself. Clients that support websockets will have the ability to perform simple informational queries, such as who is online, what version the server is running on, etc. All text based results will be returned in a simple JSON format for consistency.

• WebSocketServices Website Sample: http://www.caffeinatedrat.com/minecraft
• Author's Website: http://www.caffeinatedrat.com
• Bukkit: [http://dev.bukkit.org/server-mods/websocketservices/] (http://dev.bukkit.org/server-mods/websocketservices/)
• Bugs/Suggestions: CaffeinatedRat at gmail dot com

Notes

Some various notes about the plug-in:

• This plug-in can send fragmented frames but cannot receive it at this time.
• The total frame size can only be 2^16 in size, as larger frames will be truncated. This will not change since we want to keep this lightweight and prevent the minecraft server from being overloaded.
• All text-based services that return text-based results follow a standard JSON response.
• Other plug-ins may register for websocket events during the onLoad event with the method WebSocketServices.registerApplicationLayer(Plugin plugin, IApplicationLayer applicationLayer).

Wiki

There is a wiki available for developing on the client-side for the WebSocketServer.

• [Websockets API] (https://github.com/CaffeinatedRat/WebSocketServices/wiki/Websockets-API)
• [Websockets Client-side Library API] (https://github.com/CaffeinatedRat/WebSocketServices/wiki/WebSocketServices.min.js-Client-API)
• [General Wiki] (https://github.com/CaffeinatedRat/WebSocketServices/wiki)

Compilation

Maven is required for this project

• Install Maven 3
• Check out this repo and: mvn clean package

Coding and Pull Request Conventions

This project follows a lot of the standards that craftbukkit follows:

• This project follows the [Sun/Oracle coding standards] (http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html).
• No tabs; use 4 spaces instead.
• No trailing whitespaces.
• No CRLF line endings, LF only, put your gits 'core.autocrlf' on 'true'.
• No 80 column limit or 'weird' midstatement newlines.
• The pull request must contain code that builds without errors.
• The pull request must contain code that has been unit tested to some degree as to not fail on runtime.
• The description of your pull request should provide detailed information on the pull along with justification of the changes where applicable.

Change Log

The following contains information about new features, bug fixes, and other version changes.

2.0.0

• Major upgrade to support Spigot/CraftBukkit 1.8.
• Added support for persistent connections.
• Frame fragmentation fully supported.
• Client-side websocket code now exists in the Frame & Handshake classes.

1.3.0

• Upgraded to CraftBukkit 1.5.2-R1.0.
• Added support for nested JSON structures without the need of a collection.
• Fixed an issue with the location data for the player service with the nested JSON structure support.
• Fixed another issue with the WeatherType enumeration causing the player service to fail for CraftBukkit versions lower than 1.5.0.
• Extracted extensions from services. An extension can only be invoked by one service name, but can now have any service name assigned to it.
• Configuration file modified to support extensions.
• Fixed a major issue in the JSONHelper that enforces a decimal point in doubles & floats even if number is being localized.

1.2.0

• Upgraded to CraftBukkit 1.5.1-R0.2.
• The player service has been added to return information about a specific player.

1.1.9

• Fixed an issue with the hour being incorrectly calculated for the offlineplayers, who, and whitelist services.
• Added a listener for player logins to maintain a session time since the server does not do this already.

1.1.8

• Fixed an issue with plug-ins that had double quotes blowing up the json serialization.
• Added a raw time span value for the offlineplayers, who, and whitelist services.

1.1.7

• Updated the config.yml so that the offlinePlayers service is renamed to offlineplayers due to the case sensitive nature of the services.

1.1.6

• Changed the the response methodology, so that a response can be sent as text or binary regardless of the initial state of the request.
• Added the proper support for double & float values when serialized as JSON.
• Fixed an issue with an exception being thrown for external services created by other plug-ins.

1.1.5

• Added additional configuration validation checks.
• Added the WebSocketService version number to the ping service.
• Added the framework for the support of service arguments.

1.1.4

• Fixed an issue with WebSocketService plug-in not handling Unicode characters correctly. All frames will now be forced into UTF-8.

1.1.3

• Another major fix, this time to the JSON serialization helper class, which had an incorrect method of calculating maximum recursion depth. This more than likely impacted all services, causing the offline, whitelist, who, and plugin services to all cease working after 10 items.

1.1.2

• Fixed a major issue in the plugin service, where missing plugin information could cause the service to break.

1.1.1

• Fixed a small issue where the online time reported for a first time player was incorrectly calculated.
• Updated to use CraftBukkit 1.4.7-R1.0.

1.1.0

• Added an OfflinePlayers service.
• Added the framework for internal JSON serialization so that plug-ins that hook into this plug-in can focus on adding their data to a collection rather than having to deal with JSON formatting.
• Updated to use CraftBukkit 1.4.7.

1.0.2

• The debug configuration value in the config.yml has been changed to logging.
• Fixed the version number in the plugin.yml file.
• The default values in the config.yml have been updated to disable logging by default, as well as the disable fragmentation testing.
• Updated the handshaking response method so that it enforces a Carriage Return-Line Feed (\r\n) newline instead of an OS specific newline when responding to the browser, as per the HTTP specification.

1.0.0

• Initial Release.

To-Do

• Add necessary synchronization for threading; however, all services are read-only and the synch penalty is not currently worth it.
• A security layer for possible individual websocket logins (This will have to be some sort of temporary token, as these services work off client-side scripting and all 'password' information is available for all to see).
• Eventually add https support.
• Eventually add support for batched services to reduce the number of threads occupied by individual requests.