Upstream/pyCraft
1
0
Fork 0
mirror of https://github.com/ammaraskar/pyCraft.git synced 2024-12-23 09:08:36 +01:00
Code Issues Projects Releases Wiki Activity

Updated README.rst, now has python versions and contact information

Browse Source
This commit is contained in:
Jeppe Klitgaard 2015-04-05 22:32:17 +02:00
parent 17e89f23c8
commit ebf5caab01
1 changed files with 36 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.rst
View File

@ -10,11 +10,23 @@ pyCraft
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/>`_
`<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
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
------------
@ -22,3 +34,25 @@ Requirements
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``.