[Patchouli Template] Block Interaction

This is a template for the mod Patchouli, and it's intended to be used by modpack makers. By itself, it serves absolutely no use to players. It has only been tested with minecraft 1.12.2, compatibility with other minecraft versions is unknown.

It's intended to be used for documenting interactions added by mods such as Scavenge, CraftTweaker, KubeJS, GroovyScript etc.

Installation

Simply extrtact the .zip file onto your minecraft installation folder. Then navigate to patchouli_books\ThanasiShadoW's Patchouli Templates\en_us\templates to find the template files and copy them onto your own books' "templates" folder. 

Parameter Guide for "block_interaction_basic"

• "main_hand": The item meant to be held in the main hand (if any). (ItemStack)
• "off_hand": The item meant to be held in the off hand (if any). (ItemStack)
• "block": The block which is to be interacted with. (ItemStack)
• "click_type": Either "left" or "right". CAN'T BE BLANK! (string)
• "mainhand_result": This displays an icon next to the "main_hand" item to showcase what happens to it. The options are "keep" (doesn't display anything), "consume" (displays an exclamation mark), "unknown" (displays a question mark), "percent" (displays a percentage sign), and "damage" (displays a lightning symbol). CAN'T BE BLANK! (string)
• "offhand_result": This displays an icon next to the "off_hand" item to showcase what happens to it. The options are "keep" (doesn't display anything), "consume" (displays an exclamation mark), "unknown" (displays a question mark), "percent" (displays a percentage sign), and "damage" (displays a lightning symbol). CAN'T BE BLANK! (string)
• "block_result": This displays an icon next to the "block" item to showcase what happens to it. The options are "keep" (doesn't display anything), "consume" (displays an exclamation mark), "unknown" (displays a question mark), "percent" (displays a percentage sign), and "damage" (displays a lightning symbol). CAN'T BE BLANK! (string)
• "notes": This is a place for you to give additional information such as extra conditions or potential side effects. (string)

Parameter Guide for "block_interaction_exhaust"

• "main_hand": The item meant to be held in the main hand (if any). (ItemStack)
• "off_hand": The item meant to be held in the off hand (if any). (ItemStack)
• "block": The block which is to be interacted with. (ItemStack)
• "click_type": Either "left" or "right". CAN'T BE BLANK!
• "mainhand_result": This displays an icon next to the "main_hand" item to showcase what happens to it. The options are "keep" (doesn't display anything), "consume" (displays an exclamation mark), "unknown" (displays a question mark), "percent" (displays a percentage sign), and "damage" (displays a lightning symbol). CAN'T BE BLANK! (string)
• "offhand_result": This displays an icon next to the "off_hand" item to showcase what happens to it. The options are "keep" (doesn't display anything), "consume" (displays an exclamation mark), "unknown" (displays a question mark), "percent" (displays a percentage sign), and "damage" (displays a lightning symbol). CAN'T BE BLANK! (string)
• "block_result": This displays an icon next to the "block" item to showcase what happens to it. The options are "keep" (doesn't display anything), "consume" (displays an exclamation mark), "unknown" (displays a question mark), "percent" (displays a percentage sign), and "damage" (displays a lightning symbol). CAN'T BE BLANK! (string)
• "hunger": How much hunger this interaction consumes. It's essentially just text which is displayed in the center of the drumstick icon. By default is dark brown and bold, but it can be formatted. (string)
• "hp": How much health this interaction consumes. It's essentially just text which is displayed in the center of the heart icon.By default is dark red and bold, but it can be formatted. (string)
• "xp": How much experience (or how many levels) this interaction consumes. It's essentially just text which is displayed in the center of the orb icon.By default is dark green and bold, but it can be formatted. (string)

Parameter Guide for "block_interaction_drops"

This page is meant to be used in combination with either one of the above pages. It's just a grid with item slots for displaying potential drops of the block interaction.

"drop1" ... "drop63": Just spots on a 7x9 full-page grid for displaying items. (ItemStack)