/Minecraft-Pi-API

A description of the Minecraft Pi api and its derivatives

MIT LicenseMIT

#Minecraft Pi API ##Martin O'Hanlon (martin@ohanlonweb.com) ##http://www.stuffaboutcode.com

IN PROGRESS

##Description Minecraft: Pi Edition contains a really simple, but surprisingly versatile API that allows programmers to interact with the Minecraft world in real time using code.

Since its release the api has been migrated to other Minecraft implementations (e.g. Bukkit, Canarymod, Forge) as well as being extended

The objective of this repository is to document the api and be a reference point to ensure consistency across the implementation as well as providing a basis of discussion.

This repository:

  • describes the api, its derivatives and its extentions
  • provides information about compatibility across versions
  • holds the language specific (e.g. python, java) modules which allow programmers to access the api and its extensions

##Implementations

Todo - Links to information about the different implementations of API.

##Structure

  • api - documentation which describes the api, its versions
    • original documentation
  • python
    • (api)[python-api.md] - documentation describing the python module
    • (library)[python] - the modified python modules
  • java
    • (api)[java-api.md] - documentation describing the python module
    • (library)[java] - the modified java classes
  • LICENSES - licenses for the various projects this derives from
    • minecraft-pi-edition-LICENSE.txt - original minecraft pi edition LICENSE
    • others...

##Contributors

##Version history

  • 0.1 - in progress