diff --git a/CHANGELOG.md b/CHANGELOG.md index 6e9ec7b..3d94bca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +# GDMC-HTTP 1.4.3 (Minecraft 1.20.2) + +- FIX: `OPTIONS /` now also returns the [`DataVersion`](https://minecraft.wiki/w/Data_version) field. +- FIX: Expanded and updated documentation. + # GDMC-HTTP 1.4.2 (Minecraft 1.20.2) - FIX: `GET /biomes` do not return entries for positions beyond the world's build height range. diff --git a/README.md b/README.md index dfabdf5..e4ceae6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This is designed as a tool for the [Generative Design in Minecraft Competition ( | Minecraft version | GDMC-HTTP version | Docs | GDMC competition entries[^1] | | ----------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| 1.20.2 | 📦 [GDMC-HTTP 1.4.2](https://github.com/Niels-NTG/gdmc_http_interface/releases/tag/v1.4.2) | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/tree/v1.4.2/docs/Endpoints.md) | [2024 (TBD)](https://gendesignmc.wikidot.com/wiki:2024-settlement-generation-competition) | +| 1.20.2 | 📦 [GDMC-HTTP 1.4.3](https://github.com/Niels-NTG/gdmc_http_interface/releases/tag/v1.4.3) | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/tree/v1.4.3/docs/Endpoints.md) | [2024 (TBD)](https://gendesignmc.wikidot.com/wiki:2024-settlement-generation-competition) | | 1.19.2 | 📦 [GDMC-HTTP 1.3.3](https://github.com/Niels-NTG/gdmc_http_interface/releases/tag/v1.3.3) | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/tree/v1.3.3/docs/Endpoints.md) | [2023](https://gendesignmc.wikidot.com/wiki:2023-settlement-generation-competition) | | 1.16.5 | 📦 [GDMC-HTTP 0.4.2](https://github.com/nikigawlik/gdmc_http_interface/releases/tag/v0.4.2) | 📒 [API Docs](https://github.com/nikigawlik/gdmc_http_interface/wiki) | [2022](https://gendesignmc.wikidot.com/wiki:2022-settlement-generation-competition), [2021](https://gendesignmc.wikidot.com/wiki:2021-settlement-generation-competition) | @@ -48,21 +48,21 @@ When the HTTP interface is active, you have access to the following HTTP endpoin | HTTP method | URL | Description | Docs | |-------------|--------------|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| -| `POST` | `/commands` | Send Minecraft console commands | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Send-Commands-POST-commands) | -| `GET` | `/blocks` | Get information on blocks in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Read-blocks-GET-blocks) | -| `PUT` | `/blocks` | Place blocks | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Place-blocks-PUT-blocks) | -| `GET` | `/biomes` | Get information on biomes in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Read-biomes-GET-biomes) | -| `GET` | `/chunks` | Get raw chunk data in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Read-chunk-data-get-chunks) | -| `GET` | `/structure` | Create an NBT structure file from a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Create-NBT-structure-file-get-structure) | -| `POST` | `/structure` | Place an NBT structure file into the world | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Place-NBT-structure-file-POST-structure) | -| `GET` | `/entities` | Get information on entities in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Read-entities-GET-entities) | -| `PUT` | `/entities` | Summon entities into the world | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Create-entities-PUT-entities) | -| `PATCH` | `/entities` | Edit entities that already exist in the world | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Edit-entities-PATCH-entities) | -| `DELETE` | `/entities` | Remove entities from the world | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Remove-entities-DELETE-entities) | -| `GET` | `/players` | Get information on players in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Read-players-GET-players) | -| `GET` | `/buildarea` | Get information on the current build area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Get-build-area-GET-buildarea) | -| `GET` | `/heightmap` | Get heightmap information of the build area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Get-heightmap-GET-heightmap) | -| `OPTIONS` | `/` | Get current Minecraft and mod version | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.2/docs/Endpoints.md#Read-HTTP-interface-information-OPTIONS-) | +| `POST` | `/commands` | Send Minecraft console commands | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Send-Commands-POST-commands) | +| `GET` | `/blocks` | Get information on blocks in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Read-blocks-GET-blocks) | +| `PUT` | `/blocks` | Place blocks | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Place-blocks-PUT-blocks) | +| `GET` | `/biomes` | Get information on biomes in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Read-biomes-GET-biomes) | +| `GET` | `/chunks` | Get raw chunk data in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Read-chunk-data-get-chunks) | +| `GET` | `/structure` | Create an NBT structure file from a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Create-NBT-structure-file-get-structure) | +| `POST` | `/structure` | Place an NBT structure file into the world | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Place-NBT-structure-file-POST-structure) | +| `GET` | `/entities` | Get information on entities in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Read-entities-GET-entities) | +| `PUT` | `/entities` | Summon entities into the world | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Create-entities-PUT-entities) | +| `PATCH` | `/entities` | Edit entities that already exist in the world | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Edit-entities-PATCH-entities) | +| `DELETE` | `/entities` | Remove entities from the world | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Remove-entities-DELETE-entities) | +| `GET` | `/players` | Get information on players in a given area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Read-players-GET-players) | +| `GET` | `/buildarea` | Get information on the current build area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Get-build-area-GET-buildarea) | +| `GET` | `/heightmap` | Get heightmap information of the build area | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Get-heightmap-GET-heightmap) | +| `OPTIONS` | `/` | Get current Minecraft and mod version | 📒 [API Docs](https://github.com/Niels-NTG/gdmc_http_interface/blob/v1.4.3/docs/Endpoints.md#Read-HTTP-interface-information-OPTIONS-) | Detailed documentation of the endpoints can be found at [docs/Endpoints](./docs/Endpoints.md). diff --git a/docs/Endpoints.md b/docs/Endpoints.md index 4d39c2e..a16ef41 100644 --- a/docs/Endpoints.md +++ b/docs/Endpoints.md @@ -1,4 +1,4 @@ -# Endpoints GDMC-HTTP 1.4.2 (Minecraft 1.20.2) +# Endpoints GDMC-HTTP 1.4.3 (Minecraft 1.20.2) [TOC] diff --git a/gradle.properties b/gradle.properties index 2da282e..c5a81e0 100644 --- a/gradle.properties +++ b/gradle.properties @@ -48,7 +48,7 @@ mod_name=GDMC HTTP Interface # The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default. mod_license=MIT # The mod version. See https://semver.org/ -mod_version=1.4.2 +mod_version=1.4.3 # The group ID for the mod. It is only important when publishing as an artifact to a Maven repository. # This should match the base package used for the mod sources. # See https://maven.apache.org/guides/mini/guide-naming-conventions.html