mirror of
https://github.com/ammaraskar/pyCraft.git
synced 2024-11-22 02:08:56 +01:00
9202c4399b
Travis-CI status image is now targeted at the master branch in order to prevent an ugly "build failing" image, when the build fails on development branches.
62 lines
1.8 KiB
ReStructuredText
62 lines
1.8 KiB
ReStructuredText
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.
|
|
|
|
Python version
|
|
--------------
|
|
We aim to be compatible with the following python versions:
|
|
|
|
* Python 2.7
|
|
* Python 3.3
|
|
* Python 3.4
|
|
* PyPy
|
|
|
|
Requirements
|
|
------------
|
|
- `cryptography <https://github.com/pyca/cryptography#cryptography>`_
|
|
- `requests <http://docs.python-requests.org/en/latest/>`_
|
|
|
|
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``.
|