Metadata-Version: 2.1
Name: bedrockpy
Version: 0.1.0
Summary: Minecraft Bedrock Edition Websocket Server
License: MIT License
        
        Copyright (c) 2022 phoenixR
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://phoenixr-codes.github.io/bedrockpy/
Project-URL: Source Code, https://github.com/phoenixr-codes/bedrockpy/
Keywords: bot,minecraft,websocket
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Education
Classifier: Topic :: Games/Entertainment
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Provides-Extra: uvloop
License-File: LICENSE.txt

*********
bedrockpy
*********

bedrockpy is a library that handles a websocket
connection between your Minecraft world and your
server. This library allows you to create custom
commands and react to several events.


=========
Important
=========

This library is not meant for creating add-ons,
plugins or similar things. If you are however
looking for creating such creations, you might
take a look at `Microsofts official Minecraft
Bedrock documentation
<https://docs.microsoft.com/en-us/minecraft/creator/>`_

This library is meant to combine python knowledge
with Minecraft or execute Python code on systems
that do not provide full add-on support (such as
Bedrock Edition on Consoles).


====================
A very small example
====================

This demonstrates the basic structure of a bot
Don't worry, there is way more to create!

.. code-block:: python3
   
   import bedrock
   
   @app.event
   async def on_ready(ctx):
       print("Ready!")
   
   @app.command()
   async def hello(ctx):
   """say hello"""
       ctx.tell("Hello, World!")
   
   app.run()


`Documentation <https://phoenixr-codes.github.io/bedrockpy/>`_


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