Skip to content

Commit

Permalink
Document configurable block models. (#99)
Browse files Browse the repository at this point in the history
* Document configurable block models.

Closes #97

* Follow style guide

* Fix info block.

* Downgrade pyyaml.

---------

Co-authored-by: Peregrine05 <92183530+Peregrine05@users.noreply.github.com>
  • Loading branch information
leMaik and Peregrine05 authored Sep 18, 2024
1 parent 293dd3e commit 1324aed
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions ChunkyDocs/docs/support/minecraft_compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +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 |

## Block models

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 maintain compatibility with old resource packs, there are flags to switch to older block models. These flags can be specified in the Launcher as <samp>Java options</samp>, 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).

--8<-- "includes/abbreviations.md"
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1324aed

Please sign in to comment.