Bringing Real-Time Web Data to Your Minecraft Server with WebSocketServices
Running a Minecraft server is about more than just keeping the blocks in order. Server owners and community managers often need a quick way to check who is online, which plugins are active, or what version the server is running, without logging into the game. That is exactly where WebSocketServices comes in. This Bukkit plugin opens a lightweight, text-based bridge between your server and any modern web browser, allowing you to pull live information through WebSockets and display it on a website, blog, or custom dashboard.
What Is WebSocketServices?
WebSocketServices is an evolving plugin designed to give Bukkit-based Minecraft servers a simple web API. It uses the WebSocket protocol to let external clients, like a browser or a mobile app, send text commands and receive structured JSON responses. The plugin focuses on being light on resources, so it does not drag down server performance while keeping the door open for real-time queries. Instead of building a complex REST API from scratch, you can enable a handful of predefined services that cover the most common informational needs of a server community.
Because the communication is entirely text-based and follows a consistent JSON format, even someone with basic JavaScript skills can create a custom status page. The plugin supports only the modern WebSocket Protocol 13 (RFC 6455), which means it works seamlessly with Firefox 11+, Chrome 16+, Safari 6+, and Internet Explorer 10+.
Key Features and Services
At its core, WebSocketServices exposes a set of named services that a client can invoke. Each service returns a JSON object, and you can enable or disable any of them in the configuration file to keep your server information exactly as public or private as you like. The currently available services include:
- Info – Returns the server address, MOTD, game version, default game mode, and other fundamental details.
- WHO – Lists all players currently online, along with their display names and UUIDs if needed.
- Whitelist – Shows which players are on the server’s whitelist.
- Plugins – Outputs a list of every plugin installed on the server, including their versions.
- OfflinePlayers – Provides data about players who have visited the server but are not currently online.
- Player – Fetches detailed information about a specific player, such as their last login time or ban status.
These services turn your server into a transparent, queryable entity. You can, for instance, build a public “Who’s Online” widget for your community site, or create an internal tool that monitors plugin health without ever opening the server console. For those looking to streamline the setup process, this mod can be easily installed via the foxygame.net launcher — a convenient, flexible, and modern Minecraft launcher where you can download mods right from the menu. This approach saves time and keeps your server’s plugin folder tidy.
Installation and Setup
Getting WebSocketServices running is straightforward. Download the plugin JAR from the official repository on GitHub (CaffeinatedRat/WebSocketServices) and place it into your server’s plugins folder. After a restart or a reload, the plugin will generate a config.yml file where you can toggle each service on or off. For instance, if you want to keep your whitelist private, simply set whitelist: false in the configuration.
One important note for older versions (1.1.6 and below): there was a bug where the OfflinePlayers service would reject all calls. The fix is incredibly simple. Open the config.yml and make sure the service key is written entirely in lowercase as offlineplayers: true. Version 1.1.7 and later have this corrected automatically, but if you are updating from an older release, double-check that casing.
The plugin listens on a configurable port, and you can restrict which IP addresses are allowed to connect. This means you can safely expose the WebSocket endpoint only to your web server or a trusted set of clients, keeping unwanted traffic away from your game server.
Client-Side Integration
Once the plugin is active, you can build a client using pure HTML and JavaScript. The package includes a minified library called websocketservices.min.js that handles the connection, command sending, and JSON parsing for you. If you prefer to write everything from scratch, the API is documented on the GitHub wiki, and you can find code samples in the examples/client-side/ directory of the repository.
A working demonstration of what is possible can be seen at the sample site hosted on caffeinatedrat.com/minecraft. That page uses HTML5 and WebGL to present server information in a clean, visual way. If you run a blog or a community portal, embedding a live server status block is as simple as adding a few lines of JavaScript that connect to your server’s WebSocket address.
Extending the Plugin with Custom Services
One of the most powerful aspects of WebSocketServices is its extensibility. Other plugin developers can hook into the WebSocket server by creating their own ApplicationLayer and registering it with the static method WebSocketServices.registerApplicationLayer(Plugin plugin, IApplicationLayer applicationLayer). This means you can add entirely new services that return data from your custom game mechanics, economy plugins, or minigame stats. The core plugin stays lightweight, while the community can build a rich ecosystem of add-ons that all speak the same JSON protocol.
The full source code is open and available on GitHub under the CaffeinatedRat/WebSocketServices repository. Developers are encouraged to explore the code, suggest improvements, or fork the project to tailor it to their own needs.
Conclusion
WebSocketServices fills a niche that many server owners did not even realize they needed: a fast, low-overhead way to expose server information to the web. By using standard WebSockets and clean JSON, it integrates effortlessly with modern browsers and custom dashboards. Whether you want to show a live player count on your clan’s website, monitor your server’s health from a phone, or build a fully customized admin panel, this plugin gives you the building blocks without weighing down your server. Its active development and open-source nature mean that as Minecraft evolves, the plugin can grow alongside it, making it a smart choice for any Bukkit server looking to connect with the wider web.