30,966
ARTICLES
ON THIS WIKI
ON THIS WIKI
Patchouli
| Patchouli | |
|---|---|
| Name | Patchouli |
| Creator | Vazkii |
| Latest Version | 1.21.1-94 |
| Minecraft Version | 1.21.1 |
| CurseForge | CurseForge |
| Add-on Mods | Alchemistry Botania |
| Root Mod | Stand Alone |
| Modpacks | Direwolf20 1.16 Pack Feed The Beast Evolution Feed The Beast Interactions Feed The Beast OceanBlock 2 Feed The Beast Omnia Feed The Beast Revelation Feed The Beast Skies 2 Feed The Beast Sky Odyssey Feed The Beast StoneBlock 4 Feed The Beast Stoneblock 3 |
Patchouli is a mod by Vazkii that adds in-game guidebooks. The mod does not add any gameplay content on its own. Instead, other mods and modpacks ship their documentation as Patchouli books, and Patchouli provides the reader interface that turns those books into something the player can flip through inside the game.
Reading a guidebook
A Patchouli book in the inventory looks like a normal book item with a custom name and cover color set by the mod that supplied it. Right-clicking opens the reader window, which fills the center of the screen and pauses the game in single-player.
The book opens to a landing page chosen by the author, usually a short summary of what the book covers. From there the player picks a category, then a chapter inside that category, then an individual page. Categories and chapters are listed as illustrated tiles, each with their own icon, so the player can scan a category at a glance instead of reading every title.
The reader keeps a small toolbar along the bottom of the page for moving around the book without going back through the menus:
- Back returns to the previous screen, the same way a browser's back button works.
- Bookmarks opens a private list of pages the player has saved. Adding a bookmark is done from the bookmark icon at the top of any chapter, and bookmarks survive across game sessions.
- Reading History lists the last few chapters the player visited, which is useful for jumping back into something after closing the book.
- Index lists every chapter in the book at once. Useful for finding a chapter when the player only remembers the name.
- Search lets the player type a query, which filters chapters and pages across the whole book in real time.
Pages can also link to one another. Highlighted words inside a paragraph behave like hyperlinks: clicking one jumps to the chapter the author pointed at, and the back button returns to the previous page.
Chapters and pages
A chapter is a sequence of pages the player flips through left to right. Pages can hold formatted text, images, recipe diagrams (any vanilla or modded recipe type the author supports), spotlight entries for a specific item or block, entity displays, and visualized multiblock structures. The multiblock pages have a "Visualize" button that projects the structure as a translucent preview into the world around the player, making it easier to copy complex builds without having to keep alt-tabbing back to the book.
Some chapters are locked behind advancements. A locked chapter stays hidden until the player has completed the matching advancement, which lets a modpack hide spoilers until the player has progressed far enough to need them.
Where books come from
Any mod or modpack can ship a Patchouli book by including the book's content as data files; Patchouli reads them at load time and registers the book item automatically. The standard craft is a vanilla Book combined with whatever ingredient the book's author chose, with the resulting item carrying the right book ID baked in. Many books also appear directly in the creative inventory under Patchouli's tab.
Patchouli itself ships only the reader, the base guide-book item and a few test books used during development. If a modpack contains no other mods that define books, the only books available are those test entries.
