Understanding Patchouli Templates for Block Interactions
Modded Minecraft thrives on complex interactions — right-clicking a block with a specific item, consuming resources, or triggering hidden mechanics. For modpack creators, explaining these nuances to players can be a real headache. That is where Patchouli, the beloved in-game documentation mod, steps in. And with the right template, you can turn a messy wall of text into a clean, visual guide that players actually enjoy reading. This article dives deep into a specialized Patchouli template designed specifically for documenting block interactions, perfect for mods like Scavenge, CraftTweaker, KubeJS, or GroovyScript.
What Is Patchouli?
Patchouli is a mod that allows modpack makers to create beautiful, searchable guidebooks inside Minecraft. Instead of forcing players to alt-tab to a wiki, you can embed all your custom recipes, mechanics, and lore directly into the game. It uses JSON templates to structure pages, making it incredibly flexible. The block interaction templates we are exploring here are pre-built page layouts that visualize what happens when a player interacts with a block using certain items.
Who Needs This Template?
Strictly speaking, this template is not for casual players. It is a development tool for modpack authors who need to document custom interactions added by scripts or mods. If you are building a modpack that changes how furnaces work, adds right-click harvesting, or introduces sacrificial altars, this template will help you show players exactly what items to hold, which block to target, and what the outcome will be. It has been tested primarily with Minecraft 1.12.2, but its structure is simple enough that it may work on newer versions with minor adjustments.
The Two Core Block Interaction Templates
The template pack provides two main page types: block_interaction_basic and block_interaction_exhaust. The basic version focuses on the items and block involved, while the exhaust variant adds resource costs like hunger, health, or experience. Both are designed to be clear and intuitive, displaying icons for main hand, off hand, and the target block, along with visual indicators of what happens to each.
Parameter Guide for block_interaction_basic
When you copy the template files into your own book’s templates folder, you will find a set of parameters that control the display. Here is what each one does:
- main_hand: The item held in the main hand, if any. This is an ItemStack.
- off_hand: The item held in the off hand, if any. Also an ItemStack.
- block: The block being interacted with, represented as an ItemStack.
- click_type: Must be either "left" or "right". This field cannot be left blank.
- mainhand_result: Displays an icon next to the main hand item to show its fate. Options are "keep" (no icon), "consume" (exclamation mark), "unknown" (question mark), "percent" (percentage sign), or "damage" (lightning symbol). This is mandatory.
- offhand_result: Same as above, but for the off hand item. Cannot be blank.
- block_result: Same result icons, applied to the block. Required.
- notes: A free text field for extra conditions or side effects. Use it to mention cooldowns, required NBT data, or nearby blocks.
Parameter Guide for block_interaction_exhaust
This template builds on the basic one by adding three resource cost indicators. All the item and block parameters remain identical. The new ones are:
- hunger: A string displayed inside a drumstick icon. Defaults to dark brown bold text, but you can format it with color codes. It represents hunger cost.
- hp: Text inside a heart icon, showing health cost. Default is dark red bold.
- xp: Text inside an experience orb icon, for experience or level cost. Default is dark green bold.
These values are purely visual — they do not enforce the cost in-game. You still need to script the actual mechanics with CraftTweaker or KubeJS. The template simply communicates the expected trade-off to the player.
Adding Drop Displays
Sometimes a block interaction produces items. For that, the template includes a companion page called block_interaction_drops. It is not meant to stand alone; you use it alongside the basic or exhaust page. It provides a full 7x9 grid of item slots (labeled drop1 through drop63) where you can place ItemStacks to show potential loot. This is perfect for showing mining results or ritual outputs.
Installation and Setup
Getting started is straightforward. First, ensure Patchouli is installed in your modpack. Then, extract the template .zip file directly into your Minecraft installation folder. Navigate to patchouli_books\ThanasiShadoW's Patchouli Templates\en_us\templates and copy the template files into your own book’s "templates" directory. From there, you can reference them in your book’s JSON entries. When you are ready to share your modpack, players will see these polished pages right in the game. For those who prefer a streamlined mod management experience, the foxygame.net launcher offers a modern, flexible way to install and update modpacks, letting you download mods directly from its menu without ever leaving the client. It makes distributing your custom Patchouli books a breeze.
Why Visual Documentation Matters
Minecraft modpacks can overwhelm players with cryptic tooltips and scattered JEI entries. A well-crafted Patchouli page using these templates transforms confusion into clarity. By showing the exact items, click type, and outcomes, you reduce support questions and let players focus on the fun. The result icons — keep, consume, damage — are universally understood, even by those who skip reading the notes. And with the exhaust template, you can elegantly communicate resource costs that might otherwise be hidden in scripts.
Final Thoughts
The Patchouli block interaction template is a small but mighty tool for any modpack author working with scripted mechanics. It bridges the gap between complex backend code and player understanding. Whether you are designing a tech mod’s machine interactions or a magic mod’s altar rituals, these templates will make your documentation shine. So grab the template, customize your parameters, and give your players the in-game guide they deserve.