Skip to content

bedrock-ws/bedrockpy

Repository files navigation

bedrockpy

Minecraft: Bedrock Edition Websocket Server

bedrockpy lets you create a websocket server that is able to interact with a player in a Minecraft game. As the name suggests: this project only works with the "Minecraft: Bedrock Edition".

Documentation Status License PyPI PyPI - Downloads

Quick Links

"Show me some Code"

Code says more than a thousand words.

from bedrock.server import Server

app = Server()

@app.server_event
async def ready(ctx):
    print(f"Ready @ {ctx.host}:{ctx.port}!")

@app.game_event
async def block_broken(ctx):
    await ctx.server.run(f"title @a title Who destroyed {ctx.id}?!")

app.start("localhost", 6464)

Please refer to the "Introduction" section in the documentation in order to get started with bedrockpy.

Requirements

  • Python 3.10 or greater
  • pip (usually comes with Python)
  • Minecraft (not Java Edition) (any version)1

Installation

You can install/upgrade bedrockpy with the following command:

pip install -U bedrockpy

If you are not using Windows, you may as well enable uvloop which speeds up the server:

pip install -U "bedrockpy[fast]"

NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG.

Footnotes

  1. This only applies to the client connecting to the server.