Minecraft Interactive World Builder

Warning

UNDER DEVELOPMENT: not all features are yet available and the tutorials are not yet complete.

This project is intended as a fun way to learn the Python Programming Language. It has the following features:

• Use Python to create anything inside of Minecraft worlds.

• Call Python code when events occur inside the world.

• Use an iPython prompt to interact with the world by typing Python commands

• Have your player inside the world execute Python code by placing command signs or activating switches/levers with Python actions.

All instructions on how to set up a Minecraft Server and the Python developer environment are included. There will be a step by step tutorial to introduce Python Programming.

See Set Up to begin.

PyPI	pip install mciwb
Source code	https://github.com/gilesknap/mciwb
Documentation	https://gilesknap.github.io/mciwb
Releases	https://github.com/gilesknap/mciwb/releases

How the documentation is structured

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

Tutorials

• Set Up
  • The Minecraft Java Client
  • Docker Desktop
  • Visual Studio Code
  • Command Line
  • Python
  • Minecraft Interactive World Builder library
• Orientation
  • Get a Minecraft Server Running
  • Connect your Client to the Server
  • Connect MCIWB to the Server
  • Try out Some Action Signs
  • Experimenting with Python
  • Exiting the Python prompt
• Python Variables
  • Introduction
  • Variables, Types and Operators
  • Variables in Minecraft
• Loops
• If Then Else
• Functions
• Lists
• Dictionaries
• Classes

How-to Guides

Practical step-by-step guides for the more experienced user.

How-to Guides

• Setup for each Tutorial
• Troubleshooting
  • Minecraft Server wont start
  • Problems with Player Connection
  • Minecraft Server Logs
• Minecraft Server Config
  • Configuration of the default server
  • Running your own Server
• Backup and Restore
• Windows Subsystem for Linux
  • Adding the WSL2 extension
  • Connecting to WSL2
  • Continue with tutorial

Explanations

Explanation of how the library works and why it works that way.

Explanations

• Command Completion
• Minecraft’s Coordinate System
  • Cardinals
  • Coordinates
  • Vector Math
  • Using Coordinates (Vectors) in Python

Reference

Detailed information including autogenerated code documentation.

Reference

• Contributing
  • Running the tests
    • To run in a container
    • To run locally
  • Code Styling
  • Documentation
  • Release Process
  • Checking Dependencies
  • Updating the tools
• Releases
• Index

About the documentation

Why is the documentation structured this way?