Upstream/pyCraft
1
0
Fork 0
mirror of https://github.com/ammaraskar/pyCraft.git synced 2024-12-23 17:17:50 +01:00
Code Issues Projects Releases Wiki Activity
Minecraft-client networking library in Python
327 Commits 9 Branches 6 Tags 32 MiB
Python 99.9%
ece90fcd9d
Go to file
joo ece90fcd9d Fix: MultiBlockChangePacket reads y_coordinate wrongly.
2018-01-13 17:04:39 +00:00
bin Update testing configuration: 2017-05-19 11:58:14 +01:00
docs Update all tests, docs and code to use new packet names. 2017-08-09 20:53:54 +01:00
minecraft Fix: MultiBlockChangePacket reads y_coordinate wrongly. 2018-01-13 17:04:39 +00:00
tests Fix: test_authenticate_wrong_credentials is not marked as an Internet test. 2018-01-13 02:37:28 +00:00
.gitignore Re-add pycharm/intellij files to .gitignore 2015-04-02 21:07:26 +05:00
.travis.yml Add proper matrix for travis 2017-08-09 12:40:09 -04:00
LICENSE Licensed under Apache License, Version 2.0 2012-10-10 14:29:32 +05:00
MANIFEST.in Switched to using pylintrc file instead of command line options. 2015-04-06 15:47:22 +02:00
pylintrc Switched to using pylintrc file instead of command line options. 2015-04-06 15:47:22 +02:00
README.rst Add support for Minecraft snapshots 17w43a-18w02a (protocol 341-353). 2018-01-13 01:12:28 +00:00
requirements.txt Require cryptography<2.0 for Python 3.3, as >=2.0 only supports 3.4+. 2018-01-06 19:22:55 +00:00
setup.py Fix: some subpackages are missing from setup.py. 2018-01-13 01:02:47 +00:00
start.py start.py: cosmetic improvements. 2017-09-24 05:51:28 +01:00
tox.ini Require cryptography<2.0 for Python 3.3, as >=2.0 only supports 3.4+. 2018-01-06 19:22:55 +00:00

README.rst 

pyCraft
=======
.. image:: https://travis-ci.org/ammaraskar/pyCraft.svg?branch=master
    :target: https://travis-ci.org/ammaraskar/pyCraft
.. image:: https://readthedocs.org/projects/pycraft/badge/?version=latest
    :target: https://pycraft.readthedocs.org/en/latest
.. image:: https://coveralls.io/repos/ammaraskar/pyCraft/badge.svg?branch=master 
    :target: https://coveralls.io/r/ammaraskar/pyCraft?branch=master


Minecraft Python Client Library!

This projects aims to be a modern, Python3-compatible, well-documented library for
communication with a MineCraft server.

Detailed information for developers can be found here:
`<http://pycraft.readthedocs.org/en/latest/>`_.

``start.py`` is a basic example of a headless client using the library
Use ``start.py --help`` for the options.

Supported Minecraft versions
----------------------------
pyCraft is compatible with the following Minecraft releases:

* 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
* 1.9, 1.9.1, 1.9.2, 1.9.3, 1.9.4
* 1.10, 1.10.1, 1.10.2
* 1.11, 1.11.1, 1.11.2
* 1.12, 1.12.1, 1.12.2

In addition, some development snapshots and pre-release versions are supported:
`<minecraft/__init__.py>`_ contains a full list of supported Minecraft versions
and corresponding protocol version numbers.

Supported functionality
-----------------------
Although pyCraft is compatible any supported server, only a subset of all
packets are currently decoded or encoded by the library: those necessary
to remain connected to the server, those used for chat, and some others.

Developers wishing to use other functionality with pyCraft can contribute
by implementing the desired packets in `<minecraft/networking/packets.py>`_
and sending a pull request.

Supported Python versions
-------------------------
pyCraft is compatible with (at least) the following Python implementations:

* Python 2.7
* Python 3.3
* Python 3.4
* Python 3.5
* Python 3.6
* PyPy

Requirements
------------
- `cryptography <https://github.com/pyca/cryptography#cryptography>`_ (<=1.9 for Python 3.3)
- `requests <http://docs.python-requests.org/en/latest/>`_
- `future <http://python-future.org/>`_

The requirements are also stored in ``requirements.txt``

See the installation instructions for the cryptography library here: `<https://cryptography.io/en/latest/installation/>`_
but essentially ``pip install -r requirements.txt`` should cover everything.

Contact
-------
This project currently has 2 main developers, *Ammar Askar* and *Jeppe Klitgaard*.

GitHub
^^^^^^
The preferred method of communication is via this GitHub page.

Mail
^^^^
We can be contacted by mail:

* Ammar Askar `ammar@ammaraskar.com <mailto:ammar@ammaraskar.com>`_
* Jeppe Klitgaard `jeppe@dapj.dk <mailto:jeppe@dapj.dk>`_

IRC
^^^
We can often be found on the ``minecraftdev`` IRC on
`irc.esper.net <https://www.esper.net/>`_

We go by the names of ``ammar2`` and ``dkkline``.