Metadata-Version: 2.1
Name: mpi
Version: 1.0.0
Summary: Minecraft Pi API
Home-page: https://github.com/rdhuht/MinecraftPython/blob/master/README.md
Author: rdhuht
Author-email: xinhuaxilu6@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# MinecraftPython
Sample Python scripts and notes for using the Python mcpi library for manipulating and working with Minecraft.  
I use these scripts and the library to explore Python3.  

## Getting Started 
You'll need a Minecraft setup that supports interaction via API.  
This is most simply achieved with the Minecraft for Raspberry Pi, but can also work with full blown Minecraft Java Servers with the [Raspberry Juice Server](https://github.com/zhuowei/RaspberryJuice).  

> Details of setting up the server side are out of scope for these instructions, it is assumed you already have the server running and a game client connected.  

1. Clone down this repository.  

```bash
git clone https://github.com/rdhuht/MinecraftPython.git
cd MinecraftPython
```

2. Setup a Python virtual environment.  Python3.x was used with these examples and is recommended.  Install 

```bash
python3.7 -m venv venv
```

3. Install `MinecraftPython` 

```bash
pip install MinecraftPython
```

4. Verify all is working by running the following in an interpreter.  

```python
# use somebody else's code
from mcpi.minecraft import Minecraft

name = "Yourname"
# connect to minecraft
address = "MinecraftServerAddress"
mc = Minecraft.create(address)

# get the x,y,z (position)
entity_id = mc.getPlayerEntityId(name)
position = mc.entity.getPos()

# print position to screen
print("x: {}, y: {}, z: {}".format(position.x, position.y, position.z))
```

## Resources and References 
* [Learn to Program with Minecraft](https://nostarch.com/programwithminecraft)  
* [https://github.com/martinohanlon/mcpi](https://github.com/martinohanlon/mcpi)
* [https://github.com/zhuowei/RaspberryJuice](https://github.com/zhuowei/RaspberryJuice)
* [https://www.stuffaboutcode.com/p/minecraft-api-reference.html](https://www.stuffaboutcode.com/p/minecraft-api-reference.html) 
* [https://minecraft-stuff.readthedocs.io/en/latest/index.html](https://minecraft-stuff.readthedocs.io/en/latest/index.html)


