Installation

Prerequisites

To use GDPC, you first need to install Minecraft Java edition and the GDMC HTTP Interface mod.

The version of GDPC whose docs you’re currently looking at is compatible with GDMC HTTP versions >=1.6.0, <2.0.0 and Minecraft 1.21.4.

If you’ve correctly installed the GDMC-HTTP mod, you should be able to use the /setbuildarea command in-game:

../_images/setbuildarea.png

Installing GDPC

GDPC requires Python 3.8 or above. It is available on PyPI; to install, run:

python3 -m pip install gdpc

To update, run:

python3 -m pip install --upgrade gdpc

On Windows, you may need to replace python3 with py.

Note

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.

Note on supported Minecraft version

We list a specific compatible version of Minecraft, but most of GDPC actually supports a wide range of Minecraft versions. In particular, basic block getting and setting should work with any Minecraft version for which there is a compatible version of GDMC-HTTP. The parts of GDPC that may not be compatible with Minecraft versions other than the listed one are those that interact with “Minecraft data”. For those already familiar with GDPC, these include:

  • Rotation and flipping of individual blocks.

  • Utility functions from the minecraft_tools and editor_tools modules that generate Minecraft data, such as bookData and placeSign.

  • The WorldSlice class and associated functions like Editor.loadWorldSlice().

We have plans for fully supporting multiple versions of Minecraft simultaneously, but this probably won’t be done anytime soon.