Patchouli Block Interaction Template: Block Guide for Modpacks
Every seasoned modpack creator knows the struggle: you've spent hours tweaking recipes, scripting custom interactions, and balancing gameplay, but when players log in, they're lost. They don't understand why clicking a block with a specific item yields a certain result, or what happens when they use a tool on an unfamiliar machine. The solution has always been documentation, but writing a wiki is tedious and often goes unread. Enter Patchouli, the industry-standard mod for in-game books, and its powerful new companion: the Block Interaction Template.
This template is not a content mod. It adds no blocks, items, or mechanics to your world. Instead, it is a developer's toolkit, purpose-built for authors who use CraftTweaker, KubeJS, GroovyScript, or Scavenge to create complex block behaviors. It transforms those dry, invisible scripts into beautiful, interactive guide pages that players can actually understand. If you have ever wanted your custom interactions to be self-explanatory, this is the missing piece of your puzzle.
Getting Started with the Template
Installing the template is refreshingly straightforward. It arrives as a standard zip archive, and you simply extract it directly into your Minecraft root directory. Once unpacked, you will find a new folder structure leading to patchouli_books\ThanasiShadoW's Patchouli Templates\en_us\templates. Inside, you'll discover a set of JSON files—these are your page blueprints. Copy them into the templates folder of your own custom Patchouli book, fill in the parameters with your data, and your guide comes to life in-game.
For creators who are constantly iterating on their modpacks, having a streamlined workflow is critical. Many builders have found that using a versatile launcher simplifies the process of testing and updating. You can easily download Patchouli Block Interaction Template: Block Guide for Modpacks for Minecraft through such tools, allowing for rapid deployment and testing of your custom documentation without the usual file-management headaches.
Core Template: block_interaction_basic
The workhorse of this system is the block_interaction_basic page. It is designed to describe a simple, one-step interaction: a player clicks a block while holding specific items, and something happens. This template is strict about its fields—every parameter must be filled, or the page will fail to render correctly. Here is what you need to define:
- main_hand: The item in the player's primary hand (can be empty if not required).
- off_hand: The item in the off-hand (also can be empty).
- block: The specific block that triggers the interaction.
- click_type: Must be strictly "left" or "right"—leaving this blank will break the page.
- mainhand_result, offhand_result, block_result: Icons showing the fate of each item after the interaction.
- notes: A text field for additional conditions or side effects.
Understanding Result Icons
The result parameters accept one of five values, each displaying a unique icon next to the item. This visual language allows players to grasp the mechanic instantly without reading a single word:
- keep: The item remains unchanged (no icon shown).
- consume: The item is used up (exclamation mark).
- unknown: The outcome is not defined (question mark).
- percent: There is a chance of loss or alteration (percent sign).
- damage: The item takes durability damage (lightning bolt).
For instance, if you have a recipe where right-clicking a flint and steel on an anvil consumes coal from the off-hand, you simply set offhand_result: "consume", and the book instantly displays a clear, intuitive hint for the player.
Advanced Template: block_interaction_exhaust
When your interaction costs the player resources—hunger, health, or experience—the block_interaction_exhaust template is your go-to. It inherits all the fields from the basic template but adds three new parameters, each displayed in the center of a characteristic icon:
- hunger: How many saturation points are spent, shown on a drumstick icon in bold, dark-brown text.
- hp: Health lost, displayed on a heart icon in dark red.
- xp: Experience or levels consumed, shown on an XP orb icon with dark green text.
A crucial detail: these three fields are strings, not numbers. You can write "2 levels" or "5% of max HP" with full formatting control. This flexibility is a godsend for creating complex, hardcore mechanics where a simple number wouldn't tell the whole story.
Drop Grid: block_interaction_drops
Sometimes, a single result icon isn't enough. You need to show the player exactly what items might drop from a block. The block_interaction_drops page handles this perfectly. It works exclusively in conjunction with one of the previous templates and renders a 7x9 grid of slots, allowing you to define up to 63 items.
The parameters are straightforward: drop1, drop2, and so on up to drop63. Each is an ItemStack, meaning you can specify not just the item type, but also quantity, damage, and NBT tags. This level of detail is invaluable when documenting interactions with ore blocks, custom containers, or any block where the drop depends on the tool used or fortune enchantments. A player opening your book sees a complete table of potential rewards, eliminating guesswork.
Design Tips and Testing
Before you publish your pack, remember that this template has been tested specifically on Minecraft 1.12.2. While it may work on newer versions, you should exercise caution and thoroughly test every page in-game. A single typo in a parameter name can cause the entire page to fail silently. Also, remember that click_type and all the _result fields cannot be empty; if you are unsure of an outcome, using "unknown" is a fair and honest way to inform players that the mechanic might change in future updates.
For those wondering how to install the template, the process is simple: download the zip, extract it to your Minecraft folder, and copy the JSON files into your book's template directory. Many creators also use a dedicated launcher to manage their mods, which makes the entire setup even smoother.
Final Thoughts
The Block Interaction Template for Patchouli is an indispensable asset for any modpack author aiming to create a clear, player-friendly experience. It transforms the invisible logic of your scripts into a visual, interactive guide filled with icons, hints, and drop tables. By using these templates, you reduce repetitive questions from your community and deepen player immersion. Experiment with text formatting in the hunger, hp, and xp fields, and combine the basic template with the drop grid for complex scenarios. In the end, it is this attention to detail that elevates a good modpack to a great one.