st_minecraft

(Eine deutsche Version dieser README ist in der Datei README_DE.md verfügbar. Beachten Sie, dass die englische Version die Hauptversion ist. Die deutsche Version könnte veraltet sein.)

Library for interacting with a Minecraft server through Python programs. This is the frontend part, which requires the use of our Server Plugin on the server side.

(You need to ensure that major and minor tag of plugin and library release must match! e.g. both must be v1.1.x)

The library is designed to teach children the Python programming language playfully through interactions with Minecraft. It is not intended for production use!

We provide an english and a german version of the library.

Quick Example

import st_minecraft.en as mc
from st_minecraft.en.material import MaterialCollection

mc.connect("localhost")

while True:
  player = mc.get_player_by_name("YourPlayerName")
  mc.set_block(player.x, player.y - 1, player.z, MaterialCollection.Diamond_Block)

import st_minecraft.de as mc

mc.verbinden("localhost")

while True:
  spieler = mc.hole_spieler_durch_name("DeinSpielerName")
  mc.setze_block(spieler.x, spieler.y - 1, spieler.z, mc.MaterialSammlung.Stein)

If you're completely new to Python and programming: don't worry. Just follow the steps below and copy the example. You should see first results in a few minutes.

Available Interactions

• Interact with players
  • fetch information about player (position, stats, inventory)
  • modify player position (incl. dimension and rotation)
  • modify player stats (xp, health, hunger)
  • give items
• Interact with Blocks
  • Set Blocks
  • Fetch Blocks
• Send and receive chat messages and execute commands
• Spawn and edit entities (mobs, items, etc.)
• Create and edit boss bars
• Display titles

How to install

What You Need

• A Minecraft Java Edition server with the appropriate server plugin running. More information can be found in the documentation of the Server Plugin. If the server has been set up for you, you need the IP and port.
• Python 3.10 or newer on your computer. If not yet installed: download and install from https://www.python.org/downloads/.
  • Make sure to add Python to "PATH" during installation.
• We also recommend using PyCharm, the free version without subscription is completely sufficient!

Installation with pip

(Optional) Using a virtual eenvironment

We recommend to us a venv: Windows:

py -m venv venv
venv\Scripts\Activate.ps1

Linux/MacOS:

python3 -m venv venv
venv/bin/activate

Installing the library

You can install the library using pip:

pip install st-minecraft

You can find available versions here: https://pypi.org/project/st-minecraft/

Quickstart (copy & paste)

Examples of how to use the library can be found in demo/.

How the Library is Structured

The function names are available in german and english and kept beginner-friendly:

English examples

• Blocks: set_block(...), get_block(...)
• Players: get_player(...), set_player_position(...), set_player_health(...), set_player_hunger(...), set_player_xp_level(...), set_player_velocity(...)
• Chat & Commands: send_to_chat(...), send_command(...)
• Entities: spawn_entity(...), set_entity_name(...), set_entity_position(...), set_entity_ai(...)
• Inventory: give_item(...), get_inventory(...)

Block and entity types come from the English enums MaterialCollection and EntityCollection (e.g., MaterialCollection.Melon, EntityCollection.Sheep).

German examples

• Blocks: setze_block(...), hole_block(...)
• Players: hole_spieler(...), spieler_position_setzen(...), spieler_leben_setzen(...), spieler_hunger_setzen(...), spieler_xp_level_setzen(...), spieler_geschwindigkeit_setzen(...)
• Chat & Commands: sende_an_chat(...), sende_befehl(...)
• Entities: erzeuge_entity(...), entity_name_setzen(...), entity_position_setzen(...), entity_ai_setzen(...)
• Inventory: gebe_item(...), hole_inventar(...)

Block and entity types come from the German enums MaterialSammlung and EntitySammlung (e.g., MaterialSammlung.Melone, EntitySammlung.Schaf).

Troubleshooting

• RuntimeError: "No connection to server. Please connect first."
  • First call connect(HOST). Check the servers IP and whether the server is running.
• Timeout/No response from server
  • The server may not be reachable or the backend is not running. Also check IP and port.
• I don't know my coordinates (x, y, z)
  • Stand at the desired location in the game and press F3 to see your position. Alternatively, start with small test coordinates near the spawn.

AI Disclaimer

• Parts of the README and code have been translated using AI.
• All content has been reviewed by humans before publication.
• The logic itself was written by hand.