# WebConsoleServer<\/p>\n
A Minecraft plugin that exposes your server console through a WebSocket connection. Built for groupez.dev, a test server generator for paid plugins.<\/p>\n
## Features<\/p>\n
– Real-time console log streaming via WebSocket
\n– Password-protected authentication
\n– Log history persistence (loads previous logs on client connection)
\n– Support for both **Spigot\/Paper** and **Velocity** platforms
\n– Included test web page for quick testing<\/p>\n
## Supported Platforms<\/p>\n
| Platform | Minecraft Version | Java Version |
\n|———-|——————-|————–|
\n| Spigot\/Paper | 1.8.8+ | Java 8+ |
\n| Velocity | 3.3.0+ | Java 21+ |<\/p>\n
## Test Web Page<\/p>\n
A test web page is included in the `web\/` folder. Open `web\/index.html` in your browser to connect to the WebSocket server and view console logs in real-time.<\/p>\n
## Installation<\/p>\n
1. Download the appropriate JAR for your platform from Modrinth
\n2. Place the JAR in your server’s `plugins` folder
\n3. Restart your server
\n4. Configure the plugin in `plugins\/WebConsoleServer\/config.properties` (Velocity) or `plugins\/WebConsoleServer\/config.yml` (Spigot)<\/p>\n
## Configuration<\/p>\n
“`properties
\n# IP address to bind the WebSocket server (use 0.0.0.0 for all interfaces)
\nwebsocket-host=0.0.0.0<\/p>\n
# Port for the WebSocket server
\nwebsocket-port=8765<\/p>\n
# Password for WebSocket authentication (leave empty for no authentication)
\nwebsocket-password=changeme<\/p>\n
# Maximum number of log lines to keep in history
\nmax-log-history=500
\n“`<\/p>\n
## WebSocket Protocol<\/p>\n
### Authentication Flow<\/p>\n
1. Client connects to `ws:\/\/host:port`
\n2. Server sends `{“type”:”auth_required”}`
\n3. Client sends `{“type”:”auth”,”password”:”your_password”}`
\n4. Server responds with `{“type”:”auth_success”}` or `{“type”:”auth_failed”}`
\n5. On success, server sends log history followed by `{“type”:”history_complete”}`<\/p>\n
### Message Types<\/p>\n
| Type | Direction | Description |
\n|——|———–|————-|
\n| `auth_required` | Server \u2192 Client | Authentication is required |
\n| `auth` | Client \u2192 Server | Authentication request with password |
\n| `auth_success` | Server \u2192 Client | Authentication successful |
\n| `auth_failed` | Server \u2192 Client | Authentication failed |
\n| `log` | Server \u2192 Client | Console log message |
\n| `history_complete` | Server \u2192 Client | All historical logs have been sent |<\/p>\n
### Log Message Format<\/p>\n
“`json
\n{“type”:”log”,”message”:”[12:34:56] [INFO] [ServerName]: Your log message here”}
\n“`<\/p>\n
## Building from Source<\/p>\n
“`bash
\n# Build all modules
\n.\/gradlew build<\/p>\n
# Output JARs are located in target\/
\n# – WebConsoleServer-Spigot-1.0.jar
\n# – WebConsoleServer-Velocity-1.0.jar
\n“`<\/p>\n
On Windows, use `gradlew.bat` instead of `.\/gradlew`.<\/p>\n
## License<\/p>\n
MIT License<\/p>\n
## Links<\/p>\n
– groupez.dev – Test server generator for paid plugins
\n– Github – Source code<\/p>\n","protected":false},"excerpt":{"rendered":"
Simple web console with websocket, read only<\/p>\n","protected":false},"featured_media":169384,"template":"","meta":{"_minecraft_slug":"webconsoleserver","_minecraft_project_id":"nHiSQ5s6","_minecraft_author":"Maxlego08","_minecraft_license":"MIT","_minecraft_downloads":50,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"webconsoleserver.zip","_minecraft_size_bytes":337112,"_minecraft_version_count":2,"_minecraft_updated_at":"2026-05-15T21:05:41.024838Z","_minecraft_date_created":"2026-03-02T20:14:35.142629Z","_minecraft_date_modified":"2026-02-23T18:58:27.267122Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/webconsoleserver","_minecraft_icon_attachment_id":169384,"_minecraft_imported_at":"2026-06-09T20:11:37+00:00","_minecraft_import_hash":"455072e0c748200120bb9e7ee25c2632","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,127,128,129,123,985],"mod_loader":[132,133,134],"minecraft_version":[339,340,341,357,359,360,379,382,385,438,446,449,110,111,112,113,114,115,116,117,118,119,120,46,47,48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82,22,23,24,25,26,27,28,29,30,31,860,861,862,863,864],"class_list":["post-169383","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-technology","mod_category-velocity","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-10","minecraft_version-1-10-1","minecraft_version-1-10-2","minecraft_version-1-11","minecraft_version-1-11-1","minecraft_version-1-11-2","minecraft_version-1-12","minecraft_version-1-12-1","minecraft_version-1-12-2","minecraft_version-1-13","minecraft_version-1-13-1","minecraft_version-1-13-2","minecraft_version-1-14","minecraft_version-1-14-1","minecraft_version-1-14-2","minecraft_version-1-14-3","minecraft_version-1-14-4","minecraft_version-1-15","minecraft_version-1-15-1","minecraft_version-1-15-2","minecraft_version-1-16","minecraft_version-1-16-1","minecraft_version-1-16-2","minecraft_version-1-16-3","minecraft_version-1-16-4","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9","minecraft_version-1-8","minecraft_version-1-8-1","minecraft_version-1-8-2","minecraft_version-1-8-3","minecraft_version-1-8-4","minecraft_version-1-8-5","minecraft_version-1-8-6","minecraft_version-1-8-7","minecraft_version-1-8-8","minecraft_version-1-8-9","minecraft_version-1-9","minecraft_version-1-9-1","minecraft_version-1-9-2","minecraft_version-1-9-3","minecraft_version-1-9-4"],"yoast_head":"\n