README.rst

   1 pyCraft
   2 =======
   3 .. image:: https://app.travis-ci.com/ammaraskar/pyCraft.svg?branch=master
   4     :target: https://app.travis-ci.com/github/ammaraskar/pyCraft
   5 .. image:: https://readthedocs.org/projects/pycraft/badge/?version=latest
   6     :target: https://pycraft.readthedocs.org/en/latest
   7 .. image:: https://coveralls.io/repos/ammaraskar/pyCraft/badge.svg?branch=master
   8     :target: https://coveralls.io/r/ammaraskar/pyCraft?branch=master
   9
  10
  11 Minecraft Python Client Library!
  12
  13 This projects aims to be a modern, Python3-compatible, well-documented library for
  14 communication with a MineCraft server.
  15
  16 Detailed information for developers can be found here:
  17 `<http://pycraft.readthedocs.org/en/latest/>`_.
  18
  19 ``start.py`` is a basic example of a headless client using the library
  20 Use ``start.py --help`` for the options.
  21
  22 Supported Minecraft versions
  23 ----------------------------
  24 pyCraft is compatible with the following Minecraft releases:
  25
  26 * 1.8, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9
  27 * 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4
  28 * 1.10, 1.10.1, 1.10.2
  29 * 1.11, 1.11.1, 1.11.2
  30 * 1.12, 1.12.1, 1.12.2
  31 * 1.13, 1.13.1, 1.13.2
  32 * 1.14, 1.14.1, 1.14.2, 1.14.3, 1.14.4
  33 * 1.15, 1.15.1, 1.15.2
  34 * 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5
  35 * 1.17, 1.17.1
  36 * 1.18, 1.18.1
  37
  38 In addition, some development snapshots and pre-release versions are supported:
  39 `<minecraft/__init__.py>`_ contains a full list of supported Minecraft versions
  40 and corresponding protocol version numbers.
  41
  42 Supported functionality
  43 -----------------------
  44 Although pyCraft is compatible any supported server, only a subset of all
  45 packets are currently decoded or encoded by the library: those necessary
  46 to remain connected to the server, those used for chat, and some others.
  47
  48 Developers wishing to use other functionality with pyCraft can contribute by
  49 implementing packet classes for the desired packets, adding them under
  50 `<minecraft/networking/packets>`_, and sending a pull request.
  51
  52 Supported Python versions
  53 -------------------------
  54 pyCraft is compatible with (at least) the following Python implementations:
  55
  56 * Python 3.5
  57 * Python 3.6
  58 * Python 3.7
  59 * Python 3.8
  60 * Python 3.9
  61 * PyPy
  62
  63 Requirements
  64 ------------
  65 - `cryptography <https://github.com/pyca/cryptography#cryptography>`_
  66 - `requests <http://docs.python-requests.org/en/latest/>`_
  67 - `PyNBT <https://github.com/TkTech/PyNBT>`_
  68
  69 The requirements are also stored in ``setup.py``
  70
  71 See the installation instructions for the cryptography library here: `<https://cryptography.io/en/latest/installation/>`_
  72 but essentially ``pip install -r requirements.txt`` should cover everything.
  73
  74 Contact
  75 -------
  76 This project currently has 2 main developers, *Ammar Askar* and *Jeppe Klitgaard*.
  77
  78 GitHub
  79 ^^^^^^
  80 The preferred method of communication is via this GitHub page.
  81
  82 Mail
  83 ^^^^
  84 We can be contacted by mail:
  85
  86 * Ammar Askar `ammar@ammaraskar.com <mailto:ammar@ammaraskar.com>`_
  87 * Jeppe Klitgaard `jeppe@dapj.dk <mailto:jeppe@dapj.dk>`_
  88
  89 IRC
  90 ^^^
  91 We can often be found on the ``minecraftdev`` IRC on
  92 `irc.esper.net <https://www.esper.net/>`_
  93
  94 We go by the names of ``ammar2`` and ``dkkline``.