DiscordSource code

🗃️Inventories

Correctly configures the plugin's inventory files.

Explanations of the different settings are generally well explained. However, for a more in-depth explanation, or even examples, this page will be helpful.

1. Main configuration of the inventory

An inventory file is divided into two parts: the first part contains the global and general configuration, and the second part contains the individual items.

title: This value refers to the inventory title.

rows: This value refers to the number of rows in the inventory.

Be rigorous and logical. Don't decide to put an item in a slot that wouldn't be accessible with just two lines, for example. 1 line corresponds to 9 slots, and 6 lines corresponds to 54 slots.

inventoryScheme: This value corresponds to the desired inventory layout. There must be a list of the same size as the number of rows in the inventory. Each entry in the list must therefore be 9 characters long. The empty character (or space) corresponds to no item, while “1” corresponds to the item that can be positioned.

This value is not present in every file, because not every GUI are interactive. The value allows the plugin to handle different pages, for example, if there are a large number of home pages.

borderItem: Although this section is not included in the items section, the way to configure this item is the same as for items in general, except that the slots are a list of numbers, rather than a single number.

2. Basic configuration of an item

enabled: When available (some items are enabled by default and cannot be disabled), this value allows you to enable or disable certain items and their associated functionality, if any.

slot: This value is used to define the position of the current item..

Keep in mind that the slot starts at 0 and ends at 53. However, this maximum limit is reduced when the number of rows in the inventory is less than 6. See the inventory row configuration for more details.

material: This value is used to define the name of the item you wish to use.

For versions that still use IDs (1.12.2 and earlier), please avoid using the left side of the ID. For example, for cooked salmon (350:1), use cooked_fish, and keep the 1 for the data value.

data: This value is used to assign data to an item. (1.12.2 and earlier)

displayName: This value is used to define a display name for the item.

lore: The value is used to define a lore (= description) for the item.

Other information, such as ignored options or available variables (or placeholders), are written in comments above the item. So be sure to read all comments!

3. Advanced configuration of an item

By default, these configurations are not used. See here how they should work.

enchantments: This value is used to define a list of enchantments applied to the item. Example:

enchantments:
#  - "name:level":
  - "SHARPNESS:5"
  - "KNOCKBACK:2"

# A list of all enchantments is available here: (Latest version)
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html
# Or here: (Choose your version)
# https://helpch.at/docs/<an older version>/org/bukkit/enchantments/Enchantment.html

itemFlags: This value allows you to define a list of item flags applied to the item. Example:

itemFlags:
  - "HIDE_ENCHANTS"

# A list of all item flags is available here: (Latest version)
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/ItemFlag.html
# Or here: (Choose your version)
# https://helpch.at/docs/<an older version>/org/bukkit/inventory/ItemFlag.html

4. Special configuration of an item

Some plugins provide custom item configuration, such as the ItemsAdder plugin. However, for any requests that would require adding compatibility with another plugin, please let us know via the Discord server.

PreviousMessagesNextHomes

Last updated