diff --git a/README.md b/README.md index 539ab00..8e80152 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,49 @@ Better Shulkers focuses specifically on shulker boxes and aims to stay lightweig - **Custom labels** — shows the shulker box's custom name on the lid - **Fill bar** — a durability-style bar indicating how full the shulker box is - +## Screenshots + +### Tooltip grid preview + +Hovering over a shulker box shows its contents in a grid. The preview can appear when the box has items or always, depending on configuration. + +![Tooltip grid preview](docs/Tooltip.png) + +![Tooltip grid preview (filled shulker)](docs/TooltipFull.png) + +### In inventories and containers + +Flat top-down lid view with item hints inside a chest. The fill bar and the optional shulker-like background behind hints can each be toggled in settings. + +**With fill bar** + +![Item hints in a chest](docs/InChestPreview.png) + +![Item hints without background](docs/InChestPreviewNoBackground.png) + +**Without fill bar** (inventory slot / container — hints only, with or without background) + +![Item hints without fill bar](docs/InChestPreviewNoFillBar.png) + +![Item hints without fill bar or background](docs/InChestPreviewNoFillBarNoBackground.png) + +### Placed in the world + +Item hints appear on placed shulker boxes; custom names appear on the lid when renaming the box with an anvil. + +![Shulker lids in the world](docs/ShulkersLidsInWorld.png) + +![Shulker lid with custom label](docs/ShulkersLidWithLabelInWorld.png) + +### Configuration (Mod Menu) + +Settings are grouped under **Better Shulkers** in Mod Menu when [Cloth Config](https://modrinth.com/mod/cloth-config) is installed. + +![Mod Menu entry](docs/ModMenuEntry.png) + +![Tooltip preview options](docs/ModMenuTooltipTab.png) + +![Item hints and related options](docs/ModMenuItemHintsTab.png) ## Installation diff --git a/docs/InChestPreview.png b/docs/InChestPreview.png new file mode 100644 index 0000000..8ff51b7 Binary files /dev/null and b/docs/InChestPreview.png differ diff --git a/docs/InChestPreviewNoBackground.png b/docs/InChestPreviewNoBackground.png new file mode 100644 index 0000000..98374f1 Binary files /dev/null and b/docs/InChestPreviewNoBackground.png differ diff --git a/docs/InChestPreviewNoFillBar.png b/docs/InChestPreviewNoFillBar.png new file mode 100644 index 0000000..96c3119 Binary files /dev/null and b/docs/InChestPreviewNoFillBar.png differ diff --git a/docs/InChestPreviewNoFillBarNoBackground.png b/docs/InChestPreviewNoFillBarNoBackground.png new file mode 100644 index 0000000..8b91814 Binary files /dev/null and b/docs/InChestPreviewNoFillBarNoBackground.png differ diff --git a/docs/ModMenuEntry.png b/docs/ModMenuEntry.png new file mode 100644 index 0000000..834146f Binary files /dev/null and b/docs/ModMenuEntry.png differ diff --git a/docs/ModMenuItemHintsTab.png b/docs/ModMenuItemHintsTab.png new file mode 100644 index 0000000..2a33078 Binary files /dev/null and b/docs/ModMenuItemHintsTab.png differ diff --git a/docs/ModMenuTooltipTab.png b/docs/ModMenuTooltipTab.png new file mode 100644 index 0000000..99d8c16 Binary files /dev/null and b/docs/ModMenuTooltipTab.png differ diff --git a/docs/ShulkersLidWithLabelInWorld.png b/docs/ShulkersLidWithLabelInWorld.png new file mode 100644 index 0000000..b4b8e4b Binary files /dev/null and b/docs/ShulkersLidWithLabelInWorld.png differ diff --git a/docs/ShulkersLidsInWorld.png b/docs/ShulkersLidsInWorld.png new file mode 100644 index 0000000..760b8ca Binary files /dev/null and b/docs/ShulkersLidsInWorld.png differ diff --git a/docs/Tooltip.png b/docs/Tooltip.png new file mode 100644 index 0000000..70bf77f Binary files /dev/null and b/docs/Tooltip.png differ diff --git a/docs/TooltipFull.png b/docs/TooltipFull.png new file mode 100644 index 0000000..cda4133 Binary files /dev/null and b/docs/TooltipFull.png differ