\ud83d\udce1 SpyWebSocket<\/p>\n
SpyWebSocket is a lightweight Paper plugin that exposes a secure WebSocket API for remotely interacting with a Minecraft server.<\/p>\n
It allows external programs (such as Python scripts, bots, or automation tools) to authenticate, execute console commands, and retrieve live player data in real time using structured JSON messages.<\/p>\n
This plugin is designed for local or trusted network usage and focuses on simplicity, flexibility, and thread safety.<\/p>\n
\u2728 Features<\/p>\n
\ud83d\udd10 Authentication system
\nClients must authenticate before accessing any functionality.<\/p>\n
\ud83d\udce1 Built-in WebSocket server
\nNo proxies or external services required.<\/p>\n
\ud83e\uddf5 Thread-safe command execution
\nAll commands are dispatched on the Minecraft main thread.<\/p>\n
\ud83d\udccd Live player coordinates API
\nRetrieve world and position data for all online players.<\/p>\n
\u2699\ufe0f Fully configurable
\nHost, port, username, and password are configurable via config.yml.<\/p>\n
\ud83e\udde9 JSON-based protocol
\nSimple, human-readable messages for easy integration.<\/p>\n
\u2699\ufe0f Configuration (config.yml)
\nwebsocket:
\n host: 127.0.0.1
\n port: 8765
\n username: admin
\n password: strongpassword<\/p>\n
\u26a0\ufe0f Security warning:
\nKeep the server bound to 127.0.0.1 or protect it with a firewall.
\nThis plugin allows remote console command execution.<\/p>\n
\ud83d\udd10 Authentication<\/p>\n
Clients must authenticate first before using any other action.<\/p>\n
\u27a4 Request
\n“`
\n{
\n “type”: “auth”,
\n “username”: “admin”,
\n “password”: “strongpassword”
\n}
\n“`<\/p>\n
\u27a4 Success Response
\n“`
\n{
\n “type”: “auth_ok”
\n}
\n“`<\/p>\n
\u27a4 Failure Response
\n“`
\n{
\n “type”: “auth_fail”
\n}
\n“`<\/p>\n
\ud83e\uddfe Execute Console Commands<\/p>\n
Executes a command as the server console.<\/p>\n
\u27a4 Request
\n“`
\n{
\n “type”: “command”,
\n “command”: “say Hello from WebSocket”
\n}
\n“`<\/p>\n
Commands are executed safely on the main server thread.<\/p>\n
\ud83d\udccd Get Online Player Coordinates<\/p>\n
Returns position and world data for all online players.<\/p>\n
\u27a4 Request
\n“`
\n{
\n “type”: “get_players”
\n}
\n“`<\/p>\n
\u27a4 Response
\n“`
\n{
\n “type”: “players”,
\n “players”: {
\n “Notch”: {
\n “x”: 123.45,
\n “y”: 64.0,
\n “z”: -98.32,
\n “world”: “world”
\n },
\n “Steve”: {
\n “x”: -20.0,
\n “y”: 70.0,
\n “z”: 45.1,
\n “world”: “world_nether”
\n }
\n }
\n}
\n“`
\n\u274c Error Responses<\/p>\n
If a request is invalid or unauthorized, the server responds with:
\n“`
\n{
\n “type”: “error”,
\n “reason”: “not_authenticated”
\n}
\n“`<\/p>\n
Common error reasons:<\/p>\n
invalid_json<\/p>\n
missing_type<\/p>\n
unknown_type<\/p>\n
not_authenticated<\/p>\n
\ud83e\udde0 Use Cases<\/p>\n
Python-controlled Minecraft automation<\/p>\n
Admin dashboards or monitoring tools<\/p>\n
Twitch \/ chat integrations<\/p>\n
Live overlays or external UIs<\/p>\n
Custom moderation tools<\/p>\n
\ud83d\udee1\ufe0f Security Notes<\/p>\n
Only authenticated clients can issue commands or access data<\/p>\n
Intended for trusted environments<\/p>\n
Not recommended for public-facing servers without additional protection<\/p>\n
\ud83d\udccc Compatibility<\/p>\n
Platform: Paper<\/p>\n
Minecraft version: 1.21+<\/p>\n
Java version: 21<\/p>\n
Dependency handling: Shaded (Shadow JAR)<\/p>\n
\u26a0\ufe0f Disclaimer<\/p>\n
This plugin enables remote execution of server console commands.
\nUse responsibly and only on servers you trust.<\/p>\n","protected":false},"excerpt":{"rendered":"
SpyWebSocket is a lightweight Paper plugin that exposes a secure WebSocket API for remotely interacting with a Minecraft server.<\/p>\n","protected":false},"featured_media":147454,"template":"","meta":{"_minecraft_slug":"spywebsocket","_minecraft_project_id":"eM2Lunct","_minecraft_author":"Spy-1345a","_minecraft_license":"LGPL-3.0-only","_minecraft_downloads":11,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"spywebsocket.zip","_minecraft_size_bytes":182356,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T23:06:22.015007Z","_minecraft_date_created":"2026-02-10T00:44:13.783936Z","_minecraft_date_modified":"2026-02-08T06:51:36.958566Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/spywebsocket","_minecraft_icon_attachment_id":147454,"_minecraft_imported_at":"2026-06-08T20:16:56+00:00","_minecraft_import_hash":"af7a601a5e85f5e8601d2e2fab3e6863","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,89,126,127,129,123,92],"mod_loader":[130,132,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-147453","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-game-mechanics","mod_category-management","mod_category-paper","mod_category-spigot","mod_category-technology","mod_category-utility","mod_loader-bukkit","mod_loader-paper","mod_loader-spigot","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"],"yoast_head":"\n