https://github.com/jocopa3/PEWS-API

A Java Websocket Server API implementation for the Pocket, Windows 10, and Education Editions of Minecraft.
https://github.com/jocopa3/PEWS-API

Last synced: 3 months ago
JSON representation

A Java Websocket Server API implementation for the Pocket, Windows 10, and Education Editions of Minecraft.

• Host: GitHub
• URL: https://github.com/jocopa3/PEWS-API
• Owner: jocopa3
• Created: 2017-02-21T00:18:51.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-13T22:22:34.000Z (over 7 years ago)
• Last Synced: 2024-07-28T13:22:18.715Z (3 months ago)
• Language: Java
• Size: 384 KB
• Stars: 35
• Watchers: 11
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-minecraft-bedrock - PEWS-API - A Java Websocket Server API implementation for the Pocket, Windows 10, and Education Editions of Minecraft. (Documentation)

README

        
# Pocket Edition WebSocket Server API

This API is meant to communicate with the C++ versions of Minecraft, namely Pocket Edition, Windows 10 Edition, and Education Edition using WebSockets. This is not a full multiplayer server, and does not share the same capabilities as multiplayer servers do.

Minecraft uses WebSockets to communicate with external programs (such as the Classroom Mode App for Edu Edition) and developer tools. To connect to a WebSocket server, a user must use the `/connect` or `/wsserver` commands from the in-game chat screen. Once connected, the WebSocket server can listen for telemetry events from the game and send slash-commands (i.e. like `/kill`). A full list of all telemetry events the game tracks can be found here: https://gist.github.com/jocopa3/5f718f4198f1ea91a37e3a9da468675c

Internally, Minecraft sends JSON messages through the WebSocket to communicate to servers. A basic outline of the JSON structure of each message can be found here: https://gist.github.com/jocopa3/54b42fb6361952997c4a6e38945e306f

# Build Requirements

* [Java-WebSocket](https://github.com/TooTallNate/Java-WebSocket) by TooTallNate

* [GSON](https://github.com/google/gson) by Google

Note: this project was built with JDK 1.8, but should be compatible with 1.7.