imported>Merge: merge.py

2026-09-25T10:55:52Z

merge.py

New page

{{documentation header}}
{{lua|Inventory}}
'''Note: this template should only be used if you want to show an Inventory, or a recipe with an inventory'''. ''If you only want to show a recipe, use its respective template, e.g.'' [[Template:Furnace|<nowiki>{{Furnace}}</nowiki>]]

== General usage ==
To control the contents of the many slots of the inventory and other GUI components, the following parameters may be used.

{| class="wikitable"
! colspan="3" | Common parameters
|-
! Parameter
! Function
! Default value
|-
| type || '''Required.''' The type of GUI to show. Except for the {{code|generic}} type, it always includes the player inventory. There are '''7''' different values this property can have, as detailed below. Click on a container type to learn more about it.

{{code|[[#Survival|survival]]}} {{code|[[#Crafting Table|crafting-table]]}} {{code|[[#Furnace|furnace]]}} {{code|[[#Brewing Stand|brewing-stand]]}} {{code|[[#Anvil|anvil]]}} {{code|[[#Legacy|legacy-smithing]]}} {{code|[[#Current|smithing]] (TBA)}}
||
|-
| title || The custom title to show on the GUI || ''the default title of the GUI''
|-
| 1 – 9 || Hotbar item slots ||
|-
| 10 – 18 || Top inventory row of item slots ||
|-
| 19 – 27 || Middle inventory row of item slots ||
|-
| 28 – 36 || Bottom inventory row of item slots ||
|}

== Types ==

=== Survival ===
The {{code|survival}} type configuration displays an inventory in [[survival mode]].

{| class="wikitable"
! colspan="3" | Parameters
|-
! Parameter
! Function
! Default value
|-
| offhand || Offhand item slot ||
|-
| 103 || Head item slot ||
|-
| 102 || Body item slot ||
|-
| 101 || Legs item slot ||
|-
| 100 || Feet item slot ||
|-
| background || The background color of the player avatar preview area next to the armor slots || #000000
|-
| player || The image of the player avatar preview area, must be 98 × 140 pixels ''Note: this currently isn't working'' || [[:File:Steve inventory.png|Steve inventory.png]]
|-
| A1, B1 || Top 2×2 crafting grid slots ||
|-
| A2, B2 || Bottom 2×2 crafting grid slots ||
|-
| Output || 2×2 Crafting grid output slot ||
|-
| title || ''Note: This common parameter has no effect on the survival inventory.'' ||
|}

=== Crafting Table ===
The {{code|crafting-table}} type configuration shows a crafting table's interface.

{| class="wikitable"
! colspan="3" | Parameters
|-
! Parameter
! Function
! Default value
|-
| A1, B1, C1 || Top 3×3 crafting grid row of slots ||
|-
| A2, B2, C2 || Middle 3×3 crafting grid row of slots ||
|-
| A3, B3, C3 || Bottom 3×3 crafting grid row of slots ||
|-
| Output || 3×3 Crafting grid output slot ||
|}

=== Furnace ===
The {{code|furnace}} type configuration displays a furnace GUI.

{| class="wikitable"
! colspan="3" | Parameters
|-
! Parameter
! Function
! Default value
|-
| Input || Furnace input slot ||
|-
| Output || Furnace output slot ||
|-
| lit || Whether or not to render the fire as lit ("true" means lit, not active otherwise) || false
|-
| Fuel || Furnace fuel item slot ||
|-
| recipebook || Recipebook button item || Recipe Book
|}

=== Brewing Stand ===
The {{code|brewing-stand}} type configuration displays a brewing stand's GUI.

{| class="wikitable"
! colspan="3" | Parameters
|-
! Parameter
! Function
! Default value
|-
| Fuel || Brewing fuel input item slot ||
|-
| Input || Brewing input item slot ||
|-
| Output1 || The left bottle item slot ||
|-
| Output2 || The middle bottle item slot ||
|-
| Output3 || The right bottle item slot ||
|-
| fuel || Remaining fuel actions || 0
|-
| progress || Brewing action progress || 0
|}

=== Anvil ===
The {{code|anvil}} type configuration displays an anvil GUI.

{| class="wikitable"
! colspan="3" | Parameters
|-
! Parameter
! Function
! Default value
|-
| text || The custom text filled into the textfield of the anvil ||
|-
| Input1 || The left anvil input slot ||
|-
| Input2 || The right anvil input slot ||
|-
| Output || The anvil output slot ||
|-
| crossed || Whether or not the anvil operation (arrow) should be rendered crossed out ("true" means crossed out, normal otherwise) || false
|-
| cost || The enchantment level cost of the anvil operation, any value or "expensive" ||
|-
| expensive || Whether or not the anvil operation should be marked as too expensive ("true" means the text for the operation cost becomes dark red, bright green otherwise) || false
|}

=== Smithing Table ===

==== Legacy ====
The <code>legacy-smithing</code> type configuration displays the pre-1.20 smithing table GUI.

{| class = "wikitable"
! colspan="3" | Parameters
|-
! Parameter
! Function
! Default value
|-
| Input1 || The left input slot ||
|-
| Input2 || The right input slot ||
|-
| Output || The output slot ||
|-
| crossed || Whether or not the arrow should be crossed out || false
|}

==== Current ====
The {{code|smithing}} type configuration will display the current smithing table GUI when it is finished.

== Examples ==
=== Survival inventory ===

<pre>{{Inventory
|type=survival
|1=Silver Ingot, 20
|2=Diamond Axe
|3=Diamond Pickaxe
|4=Obsidian, 40
|36=Low Magisteel Ingot,43
|A1=Charcoal,17
|A2=Stick,20
|Output=Torch,4
|103=Silver Helmet
|102=Silver Chestplate
|101=Silver Leggings
|100=Silver Boots
}}</pre>

;Result:

{{Inventory
|type=survival
|1=Silver Ingot, 20
|2=Diamond Axe
|3=Diamond Pickaxe
|4=Obsidian, 40
|36=Low Magisteel Ingot,43
|A1=Charcoal,17
|A2=Stick,20
|Output=Torch,4
|103=Silver Helmet
|102=Silver Chestplate
|101=Silver Leggings
|100=Silver Boots
}}

=== Crafting table ===

<pre>{{Inventory
|type=crafting-table
|A1= |B1=Blaze Powder |C1=
|A2= |B2=Coal,Charcoal |C2=
|A3= |B3=Gunpowder |C3=
|Output=Fire Charge,3
|9=Obsidian,99
}}</pre>

;Result:

{{Inventory
|type=crafting-table
|A1= |B1=Blaze Powder |C1=
|A2= |B2=Coal,Charcoal |C2=
|A3= |B3=Gunpowder |C3=
|Output=Fire Charge,3
|9=Obsidian,99
}}

=== Furnace ===

<pre>{{Inventory
|type=furnace
|lit=true
|1=Damaged Wooden Axe
|2=Damaged Stone Pickaxe
|13=Granite,24
|Fuel=Coal,14
|Input=Raw Salmon,8
|Output=Cooked Salmon,56}}</pre>

;Result:

{{Inventory
|type=furnace
|lit=true
|Fuel=Coal,14
|Input=Raw Salmon,8
|Output=Cooked Salmon,56}}

=== Brewing stand ===

<pre>{{Inventory
|type=brewing-stand
|title=Magic Stand
|fuel=64
|progress=50
|Fuel=Blaze Powder,13
|Input=Nether Wart
|Output1=Awkward Potion
|Output2=Lingering Potion of Night Vision
|Output3=Antidote
}}</pre>

;Result:
{{Inventory
|type=brewing-stand
|title=Magic Stand
|fuel=64
|progress=50
|Fuel=Blaze Powder,13
|Input=Nether Wart
|Output1=Awkward Potion
|Output2=Lingering Potion of Night Vision
|Output3=Antidote
}}

=== Anvil ===

<pre>{{Inventory
|type=anvil
|text=Mystical Sword
|crossed=true
|cost=28
|expensive=true
|1=Damaged Diamond Axe
|2=Damaged Diamond Pickaxe
|3=Damaged Bow
|5=Arrow,52
|8=Stick,12
|9=Cobblestone,64
|10=Cobblestone,64
|11=Cobblestone,13
|35=Diamond,43
|Input1=[&b]Diamond Sword[&7Unbreaking VII/&7Mending]
|Input2=Enchanted Book[&7Sharpness III/&7Looting III]
|Output=[&b&oMystical Sword]Diamond Sword[&7Sharpness III/&7Looting III/&7Unbreaking VII/&7Mending//&9+9 Attack Damage]
}}</pre>

;Result:
{{Inventory
|type=anvil
|text=
|crossed=true
|cost=28
|expensive=true
|2=Diamond Axe
|3=Diamond Pickaxe
|4=
|6=
|9=
|10=
|11=
|12=
|36=
|Input1=Iron Pickaxe
|Input2=Diamond Pickaxe
|Output=Netherite Pickaxe
}}

=== Smithing Table ===

==== Legacy ====
<pre>{{Inventory
|type=legacy-smithing
|Input1=Diamond Pickaxe
|Input2=Netherite Ingot
|Output=Netherite Pickaxe
|crossed=true
}}</pre>

;Result:
{{Inventory
|type=legacy-smithing
|Input1=Diamond Pickaxe
|Input2=Netherite Ingot
|Output=Netherite Pickaxe
|crossed=true
}}

==== Current ====
<pre>{{Inventory
|type=smithing
|Input1=Netherite Upgrade Smithing Template
|Input2=Diamond Sword
|Input3=Netherite Ingot
|Output=Netherite Sword
|crossed=true
}}</pre>

;Result:
{{Inventory
|type=smithing
|Input1=Netherite Upgrade Smithing Template
|Input2=Diamond Pickaxe
|Input3=Netherite Ingot
|Output=Netherite Pickaxe
|crossed=true
}}

== See also ==
{{UI see also}}

<includeonly>

[[Category:Inventory templates]]
[[Category:Image templates]]
</includeonly>

Template:Inventory/doc - Revision history

imported>Merge: merge.py