GDMC HTTP Interface

# GDMC HTTP Interface Mod

Mod for Minecraft (Java Edition) that implements an HTTP interface for reading and writing blocks (and more).

With this interface you can use other applications and scripts running on the same machine to read and modify a Minecraft world.

This is designed as a tool for the (https://gendesignmc.wikidot.com). This annual competition for procedural AI systems in Minecraft, where the challenge is to write an algorithm that generates a settlement while adapting to pre-existing terrain. Feel free to join our (https://discord.gg/YwpPCRQWND)!

| Minecraft version | GDMC-HTTP version | Docs | GDMC competition year | |-------------------|---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 1. 21. 11 | 📦 (https://github.com/Niels-NTG/gdmc_http_interface/releases/tag/v1. 8. 4) | 📒 (https://github.com/Niels-NTG/gdmc_http_interface/tree/v1. 8. 4/docs/Endpoints.md) | (https://gendesignmc.wikidot.com/wiki:2026-settlement-generation-competition) | | 1. 21. 4 | 📦 (https://github.com/Niels-NTG/gdmc_http_interface/releases/tag/v1. 6. 0) | 📒 (https://github.com/Niels-NTG/gdmc_http_interface/tree/v1. 6. 0/docs/Endpoints.md) | (https://gendesignmc.wikidot.com/wiki:2025-settlement-generation-competition) | | 1. 20. 2 | 📦 (https://github.com/Niels-NTG/gdmc_http_interface/releases/tag/v1. 6. 0) | 📒 (https://github.com/Niels-NTG/gdmc_http_interface/tree/v1. 6. 0/docs/Endpoints.md) | (https://gendesignmc.wikidot.com/wiki:2024-settlement-generation-competition) | | 1. 19. 2 | 📦 (https://github.com/Niels-NTG/gdmc_http_interface/releases/tag/v1. 6. 0) | 📒 (https://github.com/Niels-NTG/gdmc_http_interface/tree/v1. 6. 0/docs/Endpoints.md) | (https://gendesignmc.wikidot.com/wiki:2023-settlement-generation-competition) | | 1. 16. 5 | 📦 (https://github.com/nikigawlik/gdmc_http_interface/releases/tag/v0. 4. 2) | 📒 (https://github.com/nikigawlik/gdmc_http_interface/wiki) | (https://gendesignmc.wikidot.com/wiki:2021-settlement-generation-competition), (https://gendesignmc.wikidot.com/wiki:2022-settlement-generation-competition) |

When you open a Minecraft world, you will see a chat message that the mod has opened an HTTP connection at the address `localhost:9000`. This means that you can now send HTTP requests from an external program to Minecraft while the world is open.

For testing and experimentation we recommend an API testing tool such as (https://kreya.app), (https://yaak.app), (https://httpie.io/download) or a command line tool such as `cURL` or `wget`.

When you want to build your own settlement generator or some other application, we recommend using the (https://github.com/avdstaaij/gdpc) Python library, which is purpose-built by the GDMC community to work with this mod. But any programming or scripting language that supports communication over HTTP (which includes most of them, be it either built-in or via an easy-to-use library) will work.

### HTTP Endpoints

When the HTTP interface is active, you have access to the following HTTP endpoints:

| HTTP method | URL | Description | Docs | |-------------|--------------|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| | `POST` | `/commands` | 📜 Send Minecraft console commands | 📒 (https://github.com/Niels-NTG/gdmc_http_interface/blob/v1. 8. 4/docs/Endpoints.md#-send-commands-POST-commands) | | `GET` | `/block