Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blixt/py-minecraft

A library for communicating with Minecraft clients and servers written in Python.
https://github.com/blixt/py-minecraft

Last synced: about 1 month ago
JSON representation

A library for communicating with Minecraft clients and servers written in Python.

Awesome Lists containing this project

README

        

# py-minecraft

A Python library for communicating with Minecraft clients and servers.

## Trying it out

### Minecraft wrapper

This project is an example of how to write a Minecraft wrapper. A wrapper sits
on top of the server, taking all client requests and forwarding them to the
server. The benefit of using a wrapper is that you get full control of
everything sent back and forth between the clients and the server. This can be
used for access control (for example: don't allow unknown users to place
blocks) or to allow new functionality (warping to locations, colored chat
messages, etc.)

Run this in the top directory to start the wrapper:

python -m example.wrapper.main

This will start a wrapper on port 25564 that you can connect to by entering
`localhost:25564` as the server after selecting "Multiplayer" in the client.

The wrapper expects a Minecraft server to already be running locally on port
25565.

### Minecraft server

A very simple (read: bad, slow, incomplete) implementation of a server. This is
in no way meant to actually be used, it's more a proof of concept and a test to
make sure all packet implementations work fine.

Currently the server doesn't support interaction between players other than
chatting.

Run this in the top directory to start the server:

python -m example.server.main

## MIT license

This project is licensed under an MIT license.

Copyright © 2010 Andreas Blixt