quarry

Quarry: a Minecraft protocol library

|pypi| |docs| |travis_ci|

Quarry is a Python library that implements the Minecraft protocol_. It allows you to write special purpose clients, servers and proxies.

Installation

Use pip to install quarry:

.. code-block:: console

$ pip install quarry

Features

• Supports Minecraft versions 1.7 through 1.19.2
• Supports Python 3.7+
• Built upon twisted and cryptography
• Exposes base classes and hooks for implementing your own client, server or proxy
• Implements many Minecraft data types, such as NBT, Anvil, chunk sections, command graphs and entity metadata
• Implements the design of the protocol - packet headers, modes, compression, encryption, login/session, etc.
• Implements all packets in "init", "status" and "login" modes
• Does not implement most packets in "play" mode - it is left up to you to hook and implement the packets you're interested in

.. _Minecraft protocol: http://wiki.vg/Protocol

.. |pypi| image:: https://badge.fury.io/py/quarry.svg :target: https://pypi.python.org/pypi/quarry :alt: Latest version released on PyPi

.. |docs| image:: https://readthedocs.org/projects/quarry/badge/?version=latest :target: http://quarry.readthedocs.io/en/latest :alt: Documentation

.. |travis_ci| image:: https://travis-ci.org/barneygale/quarry.svg?branch=master :target: https://travis-ci.org/barneygale/quarry :alt: Travis CI current build results