Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document configurable block models. #99

Merged
merged 4 commits into from
Sep 18, 2024
Merged

Document configurable block models. #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
98d08e9
Document configurable block models.
leMaik Sep 18, 2024
6249970
Follow style guide
Peregrine05 Sep 18, 2024
54885d4
Fix info block.
leMaik Sep 18, 2024
d94809b
Downgrade pyyaml.
leMaik Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions ChunkyDocs/docs/support/minecraft_compatibility.md
View file
Open in desktop
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
View file
Open in desktop
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