weichen0407/gdpc

A python framework for generative design in Minecraft with the GDMC-HTTP mod

GDPC - Generative Design Python Client

GDPC (Generative Design Python Client) is a Python framework for use in conjunction with the Minecraft GDMC-HTTP Mod. It is designed for the Generative Design in Minecraft Competition (GDMC).

You need to be playing in a Minecraft world with the mod installed to use the framework.

The latest version of GDPC is compatible with GDMC-HTTP versions >=1.0.0, <2.0.0.

What's the difference between GDMC, GDMC-HTTP and GDPC?

These abbreviations are all very similar, but stand for different things.

GDMC is short for the Generative Design in Minecraft Competition, a yearly competition for generative AI systems in Minecraft. The challenge is to write an algorithm that creates a settlement while adapting to the pre-existing terrain. The competition also has a Discord server.

GDMC-HTTP is a Minecraft Forge mod that provides a HTTP interface to edit the world. It allows you to modify the world live, while you're playing in it. This makes it possible to iterate quickly on generator algorithms. The mod is an official submission method for the competition.

GDPC (notice the "P") is a Python framework for interacting with the GDMC-HTTP interface. It provides many high-level tools that make working with the interface much simpler.

Installation

To install the latest stable release, type one of the following commands:

• On Linux/MacOS: python3 -m pip install gdpc
• On Windows: py -m pip install gdpc

For the latest sexy-but-might-break-something release, type the following instead:

• On Linux/MacOS: python3 -m pip install --pre gdpc
• On Windows: py -m pip install --pre gdpc

To update your package, type the following:

• On Linux/MacOS: python3 -m pip install --upgrade gdpc
• On Windows: py -m pip install --upgrade gdpc

If you would like to install the latest cutting-edge development version directly from GitHub, replace gdpc with git+https://github.com/avdstaaij/gdpc

For more information on installing from GitHub (such as getting old versions) see the pip documentation.

If you are having trouble with dependencies, download requirements.txt and try running python3 -m pip install -r requirements.txt (or py -m pip pip install -r requirements.txt if you are using Windows). You should not use requirements-dev.txt!

Tutorials and examples

There are various tutorial scripts that will help to get you started.

Some practical examples are also available, though they're slightly older and may not reflect the latest features:

• visualize_map.py: Displays a map of the Minecraft world using OpenCV.
• emerald_city.py: Demonstrates basic GDPC functionality by building a simple model of the Emerald City.