Using it

Editing the menus (guis.yml)

Every menu lives in guis.yml: main_category_gui, sub_category_gui, package_list_gui, confirmation_gui, cart_add_gui and cart_gui. Each has a title, row count (1 to 6), slots, item templates, navigation buttons and static_items. Do not change config_version; an older guis.yml is backed up and replaced automatically.

Slots are 0-based, with the top-left at 0. Use a single number (13), a range ("10-16") or a mix ("10-16,19-25,31").

main_category_gui:
  title: "&#5B8DEF&l%store_name% &8» &7Store"
  rows: 5
  category_item_slots: "10-16,19-25,28-34"
  center_items: true
  category_item:
    name: "&#5B8DEF&l%category_name%"
    lore:
      - "&8%package_count% packages"
      - ""
      - "%description%"
      - ""
      - "&7Starting at &a%starting_price%"
      - "&c⌛ &7Sale ends in &f%sale_time_left%"
      - ""
      - "&#5B8DEF» &fClick to browse"

Item options#

Available on every item section: material, name, lore, amount, glow, custom_model_data, hide_tooltip, skull_texture, skull_owner, and requires_cart: true/false to show the item only when the cart is enabled or disabled. Per GUI you can set border: false and center_items: false.

Static item actions#

Add your own buttons to any menu with static_items and one of these actions: close_gui, back, main_menu, next_page, previous_page, store_link, open_cart, cart_checkout, clear_cart, open_category:<id>, open_package:<id>, player_command:<command>, console_command:<command> (supports %player_name%) and message:<text>.

Placeholders in menus#

  • Everywhere: %player_name%, %store_name%, %store_url%, %currency_symbol%, %last_sync%, %page%, %max_pages%, %top_sale_time_left%, %cart_count%, %cart_lines%, %cart_total%.
  • Category items: %category_name%, %category_id%, %package_count%, %subcategory_count%, %starting_price%, %sale_time_left%, %description%, %description_line_<n>%.
  • Package items: %package_name%, %package_id%, %category_name%, %price%, %original_price%, %sale_price%, %original_price_if_on_sale%, %discount%, %discount_percent%, %sale_end%, %sale_time_left%, %action_hint%, %cart_quantity%, %max_quantity%, %description%, %description_line_<n>%.
  • Add-to-cart screen also: %quantity%, %total_price%, %in_cart%. Cart items also: %quantity%, %line_total%, %hint_increase%, %hint_decrease%, %hint_remove%.
Lore shortcuts

A lore line that is exactly %description% expands into the full wrapped description. A lore line containing a placeholder with no value (for example %sale_time_left% when nothing is on sale) is removed automatically, and leftover blank lines are tidied up.

Colors work everywhere: legacy &a, hex &#RRGGBB and MiniMessage like <gradient:...>. Every message players see is in messages.yml.