Patchouli ++ (Plus)

Patchouli++

Patchouli++ is an addon for Patchouli that gives book authors much more control over how pages look and behave. Every new page lives under the patchouli_plus: namespace, so your existing books keep working untouched and you can mix vanilla Patchouli pages with Patchouli++ pages in the same entry. Replacing patchouli with patchouli_plus is fully compatible; the page will remain exactly as it was, with no changes, unless you choose to modify it.

What’s different from vanilla Patchouli

• Every content page shares the same optional building blocks: title, separator and text. Use all, some or none.
• Pages can use different fillers, separators and frames, picked by name or by any ResourceLocation.
• Recipe pages hold as many recipes as you want, and recipes can alternate.
• New pages: Chapter Opening, Spotlight, a universal Recipe page and Brewing.
• Multiblock, Entity and Image pages gain new layout options.
• A bundled Test Book shows every feature in action.

Shared Page Options

All content pages (everything except Empty and Chapter Opening) are built on the Patchouli++ text page:

• title: optional, with title_position (top or high).
• separator / separators: optional separator line, with a choice of design.
• text: optional, with text_position (left or center). The text flows automatically below frames, recipes and other content.

Pages with a frame (Multiblock, Entity, Image) also accept frame and frames.

Pages

Empty

A decorative page. Use filler to turn the background on or off and fillers to choose its design.

Chapter Opening

A large, centered title that introduces a chapter or entry. title_position_chapter_opening places it at the top or the center.

Image

• Quadruple mode (quadruple): show up to four images on one page, each in its own quarter with its own frame.
• Several images per page, switched with arrow buttons placed at top_left, top_center, top_right, bottom_left, bottom_center, bottom_right or horizontal.

Link, Quest and Relations

The Link, Quest and Relations pages are rebuilt on top of the shared text page, so they get the same title, separator and text options.

Multiblock

• Eight positions for the visualize (eye) button: top_left, top_center, top_right, middle_left, middle_right, bottom_left, bottom_center and bottom_right. It can also be hidden with enable_visualize.
• Premade multiblocks: save a structure as a file and reference it by id. Put it at assets/NAMESPACE/patchouli_books/multiblocks/NAME.json and use "multiblock": { "id": "NAME" }. A bare name uses the patchouli_plus namespace, and othermod:name reads from another mod’s assets. If no file is found it tries the multiblock registry, then falls back to an inline pattern and mapping.
• A sample structure, plains_house, is included.

Entity

• Predefined poses through pose: default, display.
• scale, offset and rotate to fine-tune how the entity is shown.

Spotlight

• Show several items on one page, with row_slots (1 to 4 per row) and as many rows as you need.
• separated chooses between individual slots and joined slots.
• Any slot can be a single item, a tag or a list of alternatives that cycle.
• link_recipe links the items to the entry.

Recipes

Every recipe page has been rebuilt to support multiple recipes:

• Individual pages: crafting, smithing, smelting, blasting, smoking, campfire and stonecutting.
• Universal recipe page: put any mix of the types above on a single page, with no limit on the number of recipes.
• A list of recipes stacks them one below another. A nested list, or a comma-separated string, makes them alternate in the same slot.
• Campfire recipes alternate the station icon between campfire and soul campfire.
• Recipe results are registered with the entry, so players can open the page from the item.

Extra Options:

• station_border: draws a border around the station on every recipe type.
• crafting_toast_symbol: shows or hides the station icon on crafting recipes.
• invert_ingredients and ingredient_smithing_template: change the smithing layout.

Brewing

Name a potion and the page finds the brewing step on its own, using the brewing registry. It accepts potion and variants (normal, long, strong, splash, splash_long, splash_strong, lingering, lingering_long, lingering_strong) plus station_border and invert_ingredients. Potions stack, or alternate when nested, like the other recipe pages.

Fully Customizable Looks

Fillers, separators and frames are referenced by name or by a full ResourceLocation:

• By name, to use the bundled designs, for example "frames": "corner".
• By ResourceLocation, to use your own, for example "frames": "mymod:textures/gui/my_frame.png".

Arrays let you pick a different design for each slot, such as each quarter of a quadruple image.

Bundled Textures

Ready to use out of the box:

• Fillers: default, empty, cube, creeper
• Frames: default, simple, corner, each with a quarter version for quadruple images
• Separators: default, simple
• Images: forest, taiga, jungle, desert and an empty placeholder
• Dedicated GUI textures for recipes, crafting, spotlight and icons

All default options correspond to Patchouli’s default settings, which include Patchouli’s default textures.

You can use assets/patchouli_plus/textures/gui/crafting_improved.png. This is a texture that replaces the default visual appearance of the recipes in the Patchouli entries with that of Patchouli Plus. You can use it by placing it in the crafting_texture section of your book’s book.json file.

Patchouli Plus also adds two new sections to this part of the book.json: recipes_texture_plus and spotlight_texture_plus, which can be modified, much like Patchouli’s crafting_texture, to accommodate your own custom textures.

Other Additions

3 new commands for customizing text style.

• $(Li): for the text Lorem ipsum.
• $(false): for the text false in bold and with red color.
• $(true): for the text true in bold and with green color.

These are designed for development purposes, but can still be used in other books.

Test Book

Patchouli++ includes a Test Book (patchouli_plus:test_book), found in the Patchouli++ creative tab. It is a visual guide with an entry for each page type, showing every option in action, and it works as a template you can copy for your own book.