<p align="center">
<img
src="https://github.com/bedrock-ws/bedrockpy/blob/main/bedrockpy_3d.png?raw=true"
width="140vh"
>
<h1 align="center">bedrockpy</h1>
<p align="center">
Minecraft: Bedrock Edition Websocket Server
</p>
</p>
<!-- start brief-hook -->
*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".
[](https://bedrockpy.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/bedrock-ws/bedrockpy/blob/main/LICENSE)
[](https://pypi.org/project/bedrockpy)
[](https://pypi.org/project/bedrockpy)
## Quick Links
- 📦 [PyPI](https://pypi.org/project/bedrockpy)
- 📖 [Docs](https://bedrockpy.readthedocs.io/)
- 🐍 [Repo](https://github.com/bedrock-ws/bedrockpy/)
## "Show me some Code"
> Code says more than a thousand words.
```python
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](https://www.python.org) 3.10 or greater
- [pip](https://pip.pypa.io/en/stable/) (usually comes with Python)
- [Minecraft](https://www.minecraft.net/en-us) (**not** Java Edition) (any version)[^1]
[^1]: This only applies to the client connecting to the server.
<!-- end brief-hook -->
## Installation
<!-- start installation-hook -->
You can install/upgrade *bedrockpy* with the following command:
```console
pip install -U bedrockpy
```
If you are not using Windows, you may as well enable
[uvloop](https://github.com/MagicStack/uvloop) which speeds up
the server:
```console
pip install -U "bedrockpy[fast]"
```
<!-- end installation-hook -->
---
NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH
MOJANG.
Raw data
{
"_id": null,
"home_page": "https://github.com/bedrock-ws/bedrockpy/",
"name": "bedrockpy",
"maintainer": "Bedrock WS",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "bedrock-ws@proton.me",
"keywords": "bedrock, minecraft, websocket",
"author": "Jonas da Silva",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b7/66/15d3a358f03d421431f70051880645280c661ed22869e17572db78e81c92/bedrockpy-1.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img\n src=\"https://github.com/bedrock-ws/bedrockpy/blob/main/bedrockpy_3d.png?raw=true\"\n width=\"140vh\"\n >\n <h1 align=\"center\">bedrockpy</h1>\n <p align=\"center\">\n Minecraft: Bedrock Edition Websocket Server\n </p>\n</p>\n\n<!-- start brief-hook -->\n\n*bedrockpy* lets you create a websocket server that is able to interact\nwith a player in a Minecraft game. As the name suggests: this project\nonly works with the \"Minecraft: Bedrock Edition\".\n\n[](https://bedrockpy.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/bedrock-ws/bedrockpy/blob/main/LICENSE)\n[](https://pypi.org/project/bedrockpy)\n[](https://pypi.org/project/bedrockpy)\n\n\n## Quick Links\n\n- \ud83d\udce6 [PyPI](https://pypi.org/project/bedrockpy)\n- \ud83d\udcd6 [Docs](https://bedrockpy.readthedocs.io/)\n- \ud83d\udc0d [Repo](https://github.com/bedrock-ws/bedrockpy/)\n\n\n## \"Show me some Code\"\n\n> Code says more than a thousand words.\n\n```python\nfrom bedrock.server import Server\n\napp = Server()\n\n@app.server_event\nasync def ready(ctx):\n print(f\"Ready @ {ctx.host}:{ctx.port}!\")\n\n@app.game_event\nasync def block_broken(ctx):\n await ctx.server.run(f\"title @a title Who destroyed {ctx.id}?!\")\n\napp.start(\"localhost\", 6464)\n```\n\n*Please refer to the \"Introduction\" section in the documentation in\norder to get started with bedrockpy.*\n\n\n## Requirements\n\n- [Python](https://www.python.org) 3.10 or greater\n- [pip](https://pip.pypa.io/en/stable/) (usually comes with Python)\n- [Minecraft](https://www.minecraft.net/en-us) (**not** Java Edition) (any version)[^1]\n\n[^1]: This only applies to the client connecting to the server.\n\n<!-- end brief-hook -->\n\n\n## Installation\n\n<!-- start installation-hook -->\n\nYou can install/upgrade *bedrockpy* with the following command:\n\n```console\npip install -U bedrockpy\n```\n\nIf you are not using Windows, you may as well enable\n[uvloop](https://github.com/MagicStack/uvloop) which speeds up\nthe server:\n\n```console\npip install -U \"bedrockpy[fast]\"\n```\n\n<!-- end installation-hook -->\n\n---\n\nNOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH\nMOJANG.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Minecraft: Bedrock Edition Websocket Server",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://bedrockpy.readthedocs.io/",
"Homepage": "https://github.com/bedrock-ws/bedrockpy/",
"Repository": "https://github.com/bedrock-ws/bedrockpy/"
},
"split_keywords": [
"bedrock",
" minecraft",
" websocket"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c0a8f3e05d85c5ba7cdf1ca368654a850eae2678da2ebb7f3175193c80c0637",
"md5": "6ff4396149985c9f44cd5d98141e389c",
"sha256": "d5b752ea76566964d57c063c6e4757c4766ba51b7c89ee9f09754e286d3ab37b"
},
"downloads": -1,
"filename": "bedrockpy-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ff4396149985c9f44cd5d98141e389c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 18140,
"upload_time": "2024-06-15T13:10:41",
"upload_time_iso_8601": "2024-06-15T13:10:41.134226Z",
"url": "https://files.pythonhosted.org/packages/0c/0a/8f3e05d85c5ba7cdf1ca368654a850eae2678da2ebb7f3175193c80c0637/bedrockpy-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b76615d3a358f03d421431f70051880645280c661ed22869e17572db78e81c92",
"md5": "bddaff0dc71999c1fe77a8a3f28807cb",
"sha256": "6e602f0d9720b101ab8f93380ff9d67a2dd1db810feb2179fb296966bc478b9e"
},
"downloads": -1,
"filename": "bedrockpy-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "bddaff0dc71999c1fe77a8a3f28807cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 16217,
"upload_time": "2024-06-15T13:10:43",
"upload_time_iso_8601": "2024-06-15T13:10:43.033921Z",
"url": "https://files.pythonhosted.org/packages/b7/66/15d3a358f03d421431f70051880645280c661ed22869e17572db78e81c92/bedrockpy-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-15 13:10:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bedrock-ws",
"github_project": "bedrockpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "bedrockpy"
}
JSON
