Upstream/pyCraft
1
0
Fork 0
mirror of https://github.com/ammaraskar/pyCraft.git synced 2024-09-28 06:27:26 +02:00
Code Issues Projects Releases Wiki Activity

Rewrite README

Browse Source
This commit is contained in:
Ammar Askar 2015-03-22 19:22:51 +05:00
parent 2cc1d64b6d
commit 12eb0407a4
1 changed files with 7 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,35 +1,16 @@
pyCraft
====
Minecraft Python Client!
Minecraft Python Client Library!
Detailed information for developers can be found here:
http://pycraft.readthedocs.org/en/latest/
When running start.py, make sure you duck.
start.py is a basic example of a headless client using the library
Use `start.py --help` for the options
#Requirements
- pyCrypto 2.5 (Also in requirements.txt)
- [crpytography](https://github.com/pyca/cryptography#cryptography) (Also in requirements.txt)
##PyCrypto on Windows Systems (32 bit)
If you use Python 2.7 with win32 you're in luck, theres an installer right [here](http://www.secker.nl/wp-content/uploads/2012/03/pycrypto-2.5.win32-py2.7.exe) for pyCrypto 2.5
otherwise you're gonna need to compile it, followed by some fancy instructions on how to install pyCrypto over [here](http://www.secker.nl/2012/03/08/building-pycrypto-2-5-using-mingw-and-python-2-7-on-windows-xp/)
----------
On linux you'll need the `build-essential` and `python-dev` packages after which running `pip install -r requirements.txt`, should pull everything in.
Eventually we'll put some run instructions here but `start.py --help` should cover everything for now
#Writing Plugins for pyCraft
pyCraft has some basic plugin support, as a developer making plugins is a simple process. In the plugins folder, simply create a .py file with your plugin's name as the file name.
In your plugin.py file define a single class with the exact same spellings as your plugin file name. Now within your plugin class you'll be notified using certain methods when
things happen in the minecraft world. See the [PacketDumper plugin](https://github.com/ammaraskar/pyCraft/blob/master/plugins/PacketDumper.py) as an example. Currently these methods are
used:
```onEnable(self, parser, pluginloader)``` This fires when your plugin is loaded and passes the option parser as an argument allowing you to add custom command line options
```onDisable(self)``` This fires when pyCraft is exited cleanly, use it for cleaning up
```optionsParsed(self, parsedOptions)``` This fires when command line options have been parsed allowing you to get information from any parameters you may have added in onEnable
```packetReceive(self, packetID, receivedPacket)``` This fires when pyCraft's networking core receives a packet
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