Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/barneygale/quarry

Python library that implements the Minecraft network protocol and data types
https://github.com/barneygale/quarry

anvil client mca minecraft nbt protocol proxy python server

Last synced: about 2 months ago
JSON representation

Python library that implements the Minecraft network protocol and data types

Host: GitHub
URL: https://github.com/barneygale/quarry
Owner: barneygale
License: other
Created: 2014-07-02T19:10:31.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-03-12T08:05:38.000Z (10 months ago)
Last Synced: 2024-11-06T00:08:53.553Z (about 2 months ago)
Topics: anvil, client, mca, minecraft, nbt, protocol, proxy, python, server
Language: Python
Homepage:
Size: 611 KB
Stars: 531
Watchers: 20
Forks: 74
Open Issues: 55
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: COPYING.txt

Awesome Lists containing this project

README

        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