Skip to content

Menu Configuration

Jeremiah Osborne edited this page Feb 24, 2023 · 9 revisions

This documentation is only valid for DisplayShops 2.0 and up.


Notes

  • The material or filler-material must follow the format <material> or <material>:<durability> and can be disabled by setting it to "" or "AIR".

  • A material or filler-material option can be set to "HEAD:<id>" or "HEAD:<texture>" to obtain custom heads. Keep in mind this could be slow or harm the flow the GUI experience. In addition, Head Database heads can be used by setting the <id> portion to the id of a head's id from its database.

  • If a shop mode is set to Multi, some features like the unit-count, buy-price, or sell-price actions will open an addition menu/GUI to select a specific item being sold.

  • All menu config files need to keep their name default. The file names identify which actions are available to each menu individually. This means custom menus are not possible in DisplayShops, but the available menus can be configured to better suite your needs.


Floating Options

Floating options are simply the options that don't belong to a section like buttons.

All GUIs (Global)

Identifier Type Description
title Text The title of the inventory/menu.
size Integer Inventory size that must also be equal to 5 or otherwise divisible by 9 up to 54.
filler-material Text The material that will fill empty slots.
empty-slots Integer List All slots listed will remain empty, even if an item is set to be there. In menu that have pages, these are also the slots that are utilized for their per-page contents.

Management Menu/GUI

Identifier Type Description
sale-item-slot Integer Slot where the shop's item being sold is displayed.
trade-item-slot Integer Slot where the shop's item wanted as trade is displayed.
item-change-material Text Material of the shop item or trade item will be set to during selection.
item-change-name Text The name that will be used for item replacement during selection.

Amount Selector Menu/GUI

Identifier Description
custom-amount-entry This is a unique section that customizes the per-menu anvil custom entry menu takes a title, text, and invalid option. The text and invalid will be used in the entry box.

Button Actions

Button actions are the sub-sections under the buttons section which represent all the different actions able to be performed.

Edit Menu/GUI

Identifier Description
mode-switch Cycles through the different modes and sets the currently shown to the shop's current mode.
management Opens the management inventory/gui associated to the current shop.
settings Opens the settings inventory/gui associated to the current shop.
assistants Opens the assistant management inventory/gui associated to the current shop.

Management Menu/GUI

Identifier Description
shop-item-arrow A display item to guide the player to use the item next to it.
shop-trade-arrow A display item to guide the player to use the item next to it.
buy-price Displays current buy price and allows adjustment to the shop's buy price.
sell-price Displays current sell price and allows adjustment to the shop's sell price.
buy-player-limit Displays current buy per-player limit and allows adjustment to it.
sell-player-limit Displays current sell per-player limit and allows adjustment to it.
buy-global-limit Displays current buy global limit and allows adjustment to it.
sell-global-limit Displays current sell global limit and allows adjustment to it.
balance Displays current balance and allows adjustment to it.
appearance Allows adjustment to the shop's appearance (Base-Block).
description Displays current description and allows adjustment to it. An empty line is automatically inserted after the description line to fix tool-tip spacing.
delete Begins the process of completely deleting the shop.
return Returns the player to the previous menu/GUI.

Settings Menu/GUI

Identifier Description

Assistants Menu/GUI

Identifier Description

Button Options

The options defined below are unique to each button in an inventory/gui. In addition, a button does NOT require each option. For example, a button may be defined with just material and name, if desired.

Identifier Type Description
slot Integer Location from 0-53 where the item will appear in the inventory/gui.
material Text The material and durability (Durability is optional) of the item/button.
amount Integer The stack size of the item/button.
custom-model-data Integer The custom model data of the item/button.
enchants Text List A list of enchants for the item in the format <enchant>:<level>
flags Text List A list of all flags to apply to the item/button.
name Text Color translatable text used as the item/button name.
lore Text List Color translatable list of text used for the item/button lore.