Upstream/pyCraft
1
0
Fork 0
mirror of https://github.com/ammaraskar/pyCraft.git synced 2024-11-16 07:15:24 +01:00
Code Issues Projects Releases Wiki Activity
Minecraft-client networking library in Python
161 Commits 9 Branches 6 Tags 32 MiB
Python 99.9%
0ac27a940c
Go to file
Jeppe Klitgaard 0ac27a940c Switched to using pylintrc file instead of command line options. 
This was done because we have a lot of messages we want to ignore (disabled-locally, enabled-locally, etc, etc), which would take up a huge amount of messy space in tox.ini.
2015-04-06 15:47:22 +02:00
bin Fixed coveralls. Jeez I'm an idiot sometimes. Often times 2015-04-06 02:35:04 +02:00
docs Read the docs will always default to their theme, no need to explicitly define it there 2015-04-02 21:14:44 +05:00
minecraft id is a reserved name, even as an attribute. We now use id_ instead 2015-04-06 15:44:51 +02:00
tests Quick little base test for connection 2015-04-03 22:04:45 +05:00
.gitignore Re-add pycharm/intellij files to .gitignore 2015-04-02 21:07:26 +05:00
.travis.yml Fixed coveralls. Jeez I'm an idiot sometimes. Often times 2015-04-06 02:34:04 +02: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 Updated README.rst, now has python versions and contact information 2015-04-05 22:32:17 +02:00
requirements.txt Updated authentication.py and made it work with the rest of pyCraft 2015-04-01 23:38:10 +02:00
setup.py Improved setup.py 2015-04-01 18:56:55 +02:00
start.py Fixed some left-overs from the old authentication system 2015-04-06 02:13:34 +02:00
tox.ini Switched to using pylintrc file instead of command line options. 2015-04-06 15:47:22 +02:00

README.rst 

pyCraft
=======
.. image:: https://travis-ci.org/ammaraskar/pyCraft.svg
    :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>`_ (Also 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``.