Skip to main content

Minecraft: Bedrock Edition Websocket Server

Project description

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]

[^1]: This only applies to the client connecting to the server.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bedrockpy-1.0.1.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bedrockpy-1.0.1-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file bedrockpy-1.0.1.tar.gz.

File metadata

  • Download URL: bedrockpy-1.0.1.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.11.12 Linux/6.14.9-arch1-1

File hashes

Hashes for bedrockpy-1.0.1.tar.gz
Algorithm Hash digest
SHA256 09079e1db0a9cb73688834af86b9d1a9c2db929808e582137dc49bce8f92db49
MD5 f8c09a17b3dae5c2e45c7b3f0c4fd13b
BLAKE2b-256 5cb720f35a6a970e25e90d303d09e8f54f04b4f12256835a662776940823b0c7

See more details on using hashes here.

File details

Details for the file bedrockpy-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: bedrockpy-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.11.12 Linux/6.14.9-arch1-1

File hashes

Hashes for bedrockpy-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 00389da0d7f0eb135c02f26d972e4d3593ed2a6e0768c2d4b078a68234398cbe
MD5 120744cfb191e6c3f5833db7550bfd20
BLAKE2b-256 2a86aac3f5b956b16703f11be675a693bb391108de397217f94bb9afa5a439c2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page