Skip to content

Commit

Permalink
docs: describe legacy rendering property
Browse files Browse the repository at this point in the history
  • Loading branch information
klikli-dev committed Jun 23, 2024
1 parent 58d2f31 commit 78ddc15
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/basics/page-types/image-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,15 @@ See [Book.json](../structure/book) for details.
### **images** (ResourceLocation[], _mandatory_)

Array of ResourceLocations of the textures to display.
The files should be 256px by 256px. The upper 200px by 200px will be rendered.
By default an image of any size can be used and will be rendered entirely. See `use_legacy_rendering` for more information.


### **use_legacy_rendering** (Boolean, _optional_)
Defaults to `false`.

If true, the image will be rendered using the legacy rendering setup that matches the behaviour in Patchouli.
The files should be 256px by 256px. The upper left 200px by 200px will be rendered.
Larger images work too but the top left box matching the relative size of the 200px by 200px box will be rendered.

### **text** (DescriptionId or Component JSON, _optional_)

Expand Down

0 comments on commit 78ddc15

Please sign in to comment.