Skip to content

Commit 1324aed

Browse files
leMaikPeregrine05
andauthored
Document configurable block models. (#99)
* Document configurable block models. Closes #97 * Follow style guide * Fix info block. * Downgrade pyyaml. --------- Co-authored-by: Peregrine05 <[email protected]>
1 parent 293dd3e commit 1324aed

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

ChunkyDocs/docs/support/minecraft_compatibility.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,18 @@ Below is a list of the Minecraft versions currently supported by Chunky and ever
2323
| Campfire with items | Not supported | Not supported | In development | #1704 |
2424
| Armor trims | Not supported | Planned | Planned | #1708 |
2525

26+
## Block models
27+
28+
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.
29+
30+
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.
31+
32+
| Block | Flag | Values | Note |
33+
| ----- | -------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
34+
| 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) |
35+
36+
!!! info "Unsupported block models"
37+
38+
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).
39+
2640
--8<-- "includes/abbreviations.md"

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ mkdocs==1.6.1
1111
mkdocs-macros-plugin==1.0.4
1212
mkdocs-material==9.5.35
1313
nltk==3.6.2
14-
PyYAML==6.0
14+
PyYAML==5.3.1
1515
regex==2022.4.24
1616
six==1.16.0
1717
tornado==6.1

0 commit comments

Comments
 (0)