From 98d08e936e0b4141cad378d0528f6e3fb3d2a99a Mon Sep 17 00:00:00 2001 From: Maik Marschner Date: Wed, 18 Sep 2024 20:05:48 +0200 Subject: [PATCH 1/4] Document configurable block models. Closes #97 --- ChunkyDocs/docs/support/minecraft_compatibility.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/ChunkyDocs/docs/support/minecraft_compatibility.md b/ChunkyDocs/docs/support/minecraft_compatibility.md index af7c629..285f1ab 100644 --- a/ChunkyDocs/docs/support/minecraft_compatibility.md +++ b/ChunkyDocs/docs/support/minecraft_compatibility.md @@ -24,3 +24,17 @@ Below is a list of the Minecraft versions currently supported by Chunky and ever | Armor trims | Not supported | Planned | Planned | #1708 | --8<-- "includes/abbreviations.md" + +## Block models + +Sometimes Minecraft changes the block models or textures (and texture mappings) of existing blocks. By default, Chunky uses the _latest_ block models of the Java Edition. + +To keep compatible with old resource packs, there are flags to switch to older block models. These flags can be specified in the launcher as _Java options_, eg. `-Dchunky.blockModels.cocoa=pre-1.19` to switch to the old cocoa plant model. + +| Block | Flag | Values | Note | +| ----- | ------------------------ | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| cocoa | `chunky.blockModels.cocoa` | `1.19` (default), `pre-1.19` | Block model changed in 1.19, stage 2 cocoa plant is displayed incorrectly when the resource pack and block model don't match (see #1761) | + +!!! info "Unsupported block models" + + If you're missing an old block model or encounter issues with a block when using a resource pack that is made for an older Minecraft version, please [create an issue](https://github.com/chunky-dev/chunky/issues/new/choose). We will add support for all block models that are present in release versions of Minecraft (ie. block models that only appeared in snapshots will not be supported). From 6249970a5b9367d0b08c57db55b8b7d640fbb5f0 Mon Sep 17 00:00:00 2001 From: Peregrine05 <92183530+Peregrine05@users.noreply.github.com> Date: Wed, 18 Sep 2024 20:25:47 +0200 Subject: [PATCH 2/4] Follow style guide --- .../docs/support/minecraft_compatibility.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/ChunkyDocs/docs/support/minecraft_compatibility.md b/ChunkyDocs/docs/support/minecraft_compatibility.md index 285f1ab..0a24282 100644 --- a/ChunkyDocs/docs/support/minecraft_compatibility.md +++ b/ChunkyDocs/docs/support/minecraft_compatibility.md @@ -23,18 +23,18 @@ Below is a list of the Minecraft versions currently supported by Chunky and ever | Campfire with items | Not supported | Not supported | In development | #1704 | | Armor trims | Not supported | Planned | Planned | #1708 | ---8<-- "includes/abbreviations.md" - ## Block models -Sometimes Minecraft changes the block models or textures (and texture mappings) of existing blocks. By default, Chunky uses the _latest_ block models of the Java Edition. +Mojang sometimes changes the block models or textures (and texture mappings) of existing blocks. By default, Chunky uses the *latest* block models of Java Edition. -To keep compatible with old resource packs, there are flags to switch to older block models. These flags can be specified in the launcher as _Java options_, eg. `-Dchunky.blockModels.cocoa=pre-1.19` to switch to the old cocoa plant model. +To maintain compatibility with old resource packs, there are flags to switch to older block models. These flags can be specified in the Launcher as Java options, eg. `-Dchunky.blockModels.cocoa=pre-1.19` to switch to the old cocoa plant model. -| Block | Flag | Values | Note | -| ----- | ------------------------ | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| cocoa | `chunky.blockModels.cocoa` | `1.19` (default), `pre-1.19` | Block model changed in 1.19, stage 2 cocoa plant is displayed incorrectly when the resource pack and block model don't match (see #1761) | +| Block | Flag | Values | Note | +| ----- | -------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| cocoa | `chunky.blockModels.cocoa` | `1.19` (default), `pre-1.19` | Block model changed in 1.19; stage 2 cocoa plant is displayed incorrectly when the resource pack and block model don't match (see #1761) | !!! info "Unsupported block models" - If you're missing an old block model or encounter issues with a block when using a resource pack that is made for an older Minecraft version, please [create an issue](https://github.com/chunky-dev/chunky/issues/new/choose). We will add support for all block models that are present in release versions of Minecraft (ie. block models that only appeared in snapshots will not be supported). +If you're missing an old block model or encounter issues with a block when using a resource pack that is made for an older Minecraft version, please [create an issue](https://github.com/chunky-dev/chunky/issues/new/choose). We will add support for all block models that are present in release versions of Minecraft (ie. block models that only appeared in snapshots will not be supported). + +--8<-- "includes/abbreviations.md" From 54885d46afb22abe4b7d55f8e694f1d0c4f8aad0 Mon Sep 17 00:00:00 2001 From: Maik Marschner Date: Wed, 18 Sep 2024 20:28:46 +0200 Subject: [PATCH 3/4] Fix info block. --- ChunkyDocs/docs/support/minecraft_compatibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ChunkyDocs/docs/support/minecraft_compatibility.md b/ChunkyDocs/docs/support/minecraft_compatibility.md index 0a24282..dfb84cb 100644 --- a/ChunkyDocs/docs/support/minecraft_compatibility.md +++ b/ChunkyDocs/docs/support/minecraft_compatibility.md @@ -35,6 +35,6 @@ To maintain compatibility with old resource packs, there are flags to switch to !!! info "Unsupported block models" -If you're missing an old block model or encounter issues with a block when using a resource pack that is made for an older Minecraft version, please [create an issue](https://github.com/chunky-dev/chunky/issues/new/choose). We will add support for all block models that are present in release versions of Minecraft (ie. block models that only appeared in snapshots will not be supported). + If you're missing an old block model or encounter issues with a block when using a resource pack that is made for an older Minecraft version, please [create an issue](https://github.com/chunky-dev/chunky/issues/new/choose). We will add support for all block models that are present in release versions of Minecraft (ie. block models that only appeared in snapshots will not be supported). --8<-- "includes/abbreviations.md" From d94809b0687aab4233a032a2b91be8f7c3db0801 Mon Sep 17 00:00:00 2001 From: Maik Marschner Date: Wed, 18 Sep 2024 20:36:54 +0200 Subject: [PATCH 4/4] Downgrade pyyaml. --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d529582..129a82f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,7 +11,7 @@ mkdocs==1.6.1 mkdocs-macros-plugin==1.0.4 mkdocs-material==9.5.35 nltk==3.6.2 -PyYAML==6.0 +PyYAML==5.3.1 regex==2022.4.24 six==1.16.0 tornado==6.1