47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
# Minecraft: Pi edition API Python Library
|
|
|
|
`mcpi` Python library for communicating with [Minecraft: Pi edition](https://minecraft.net/en-us/edition/pi/) and [RaspberryJuice](https://github.com/zhuowei/RaspberryJuice).
|
|
|
|
## Installation
|
|
|
|
### Windows
|
|
|
|
```
|
|
pip3 install mcpi
|
|
```
|
|
|
|
### Linux / MacOS
|
|
|
|
```bash
|
|
sudo pip3 install mcpi
|
|
```
|
|
|
|
## History
|
|
|
|
The [Minecraft: Pi edition](https://minecraft.net/en-us/edition/pi/) Python library was originally created by Mojang and released with Minecraft: Pi edition.
|
|
|
|
Initial supported was provided for Python 2 only, but during a sprint at PyconUK 2014 it was migrated to Python 3 and [py3minepi](https://github.com/py3minepi/py3minepi) was created.
|
|
|
|
The ability to hack Minecraft from Python was very popular and the [RaspberryJuice](https://github.com/zhuowei/RaspberryJuice) plugin was created for Minecraft Java edition. RaspberryJuice also extended the API adding additional features.
|
|
|
|
This python library supports Python 2 & 3 and Minecraft: Pi edition and RaspberryJuice.
|
|
|
|
Documentation for the Minecraft: Pi edition and RaspberryJuice API's can be found at [www.stuffaboutcode.com/p/minecraft-api-reference.html](http://www.stuffaboutcode.com/p/minecraft-api-reference.html).
|
|
|
|
It was released onto [PyPI](https://pypi.org) in May 2018.
|
|
|
|
If you want some cool additional tools for modifying Minecraft, check out [minecraft-stuff](https://minecraft-stuff.readthedocs.io/en/latest/).
|
|
|
|
## Sources
|
|
|
|
This library is a collection of the following sources:
|
|
|
|
+ [Minecraft: Pi edition](https://minecraft.net/en-us/edition/pi/)
|
|
+ [Python 3 Minecraft: Pi edition library](https://github.com/py3minepi/py3minepi)
|
|
|
|
## Licenses
|
|
|
|
+ mcpi - [LICENSE.txt](https://github.com/martinohanlon/mcpi/blob/master/LICENSE)
|
|
+ Minecraft: Pi edition LICENSE - [minecraft-pi-edition-LICENSE.txt](https://github.com/martinohanlon/mcpi/blob/master/minecraft-pi-edition-LICENSE.txt)
|
|
|