mciwb

Minecraft Interactive World Builder

This project is intended as a fun way to learn the Python Programming Language.

Experienced Python programmers can also use this library to create Minecraft worlds with interactive Python features.

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

Quick Start

To get started learning Python, see Introduction

For existing Python developers, see API documentation

Example Build

The pagoda and castle with working portcullis were all created programmatically with Python and the current version of MCIWB.

https://github.com/gilesknap/mciwb/assets/964827/026b3551-f514-403a-bebe-8d168c7170b0

Goals

Minecraft Interactive World Builder’s goals are:

• 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 are step by step tutorials to introduce Python Programming and the features of Minecraft Interactive World Builder.

.. note::

This is a work in progress. There are now enough tutorials to learn the
fundamentals of Python and enough functionality to have some fun
interacting with Minecraft from Python code.

I will continue to expand the tutorials and add more features to the
library.

Credits

This project would not be possible without mcipc, which provides the client library for Minecraft RCON.

How the documentation is structured

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

• Tutorials
  • Introduction
  • Installation
  • Orientation
  • Python Variables
  • Loops
  • Functions
  • Modules and Packages
  • If - Else
  • Lists
  • Classes
  • Dictionaries
  • Running Code in the Background
  • Levers and Switches
  • Action Signs
  • Moving Structures
  • Installation

Tutorials for installation and typical usage. New users start here.

• How-to Guides
  • Backup and Restore
  • Command Completion
  • Contribute to the project
  • Discovering the Coordinates of a Block
  • VSCode Extensions
  • Run in a container
  • Setup for each Tutorial
  • Troubleshooting
  • Windows Subsystem for Linux

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

• Explanations
  • Minecraft’s Coordinate System
  • Architectural Decision Records
  • About the documentation
  • Comparison with Minecraft Education Edition
  • MCIPC Client object
  • Variable Scope
  • Minecraft Server Config

Explanations of how it works and why it works that way.

• Reference
  • API
  • Demo Code
  • Index

Technical reference material including APIs and release notes.