Shop Configuration

Description lines shown when hovering over the item. Supports MiniMessage formatting. These appear below the auto-generated price/stock information in the shop GUI.

lore:
  - "A powerful weapon"
  - "forged in the"
  - "Depths of Hell"
  - ""
  - "Special Ability:"
  - "• Fire Aspect"

The price players pay to purchase this item. Set to 0 or negative to make the item unbuyable (unless buyable is explicitly set). Price is for the quantity specified in amount.

buyPrice: 100.0   # Costs 100 currency
buyPrice: 0.0     # Free item
buyPrice: 9999.99 # Expensive rare item

The price players receive when selling this item. Set to 0 or negative to prevent selling. Price is for the quantity specified in amount.

sellPrice: 50.0   # Players get 50 currency
sellPrice: 0.0    # Cannot sell this item

Whether players can purchase this item. When false, the buy price will not be displayed and players cannot left-click to buy.

buyable: false  # Sell-only item (players can only sell to shop)
buyable: true   # Can be purchased

Whether players can sell this item to the shop. When false, the sell price will not be displayed and players cannot right-click to sell.

sellable: false  # Buy-only item (shop sells but doesn't buy)
sellable: true   # Can be sold to shop

The inventory slot (0-indexed) where this item appears in the category GUI. Must be within the page layout considering items-per-page. Avoid slots used for navigation buttons (typically last row).

slot: 10  # Position on the page
page: 1   # Which page this appears on

Which page of the category this item appears on. Categories support multiple pages of items. Page 1 is the first page.

page: 1  # First page
page: 2  # Second page (requires items-per-page to be exceeded)

Optional permission required to view and purchase this item. Players without this permission will not see the item in the shop.

permission: "essentialsc.shop.legendary"
permission: "vip.shop.access"

The available quantity of this item in the shop. Set to -1 for unlimited stock. When set to a positive number, each purchase decrements the stock. When stock reaches 0, the item cannot be purchased until restocked.

stock: -1     # Unlimited stock (default)
stock: 100    # Limited to 100 purchases
stock: 0      # Out of stock (unbuyable)

Maximum stack size for this item when shift-clicking to buy/sell stacks. Normally 64 for most items, but can be set lower for items like ender pearls (16), snowballs (16), etc.

maxStack: 64  # Standard stack size
maxStack: 16  # For ender pearls, snowballs, buckets
maxStack: 1   # For unstackable items

Commands executed when this item is purchased. Use {player} as a placeholder for the buyer's name. Commands are executed by the console. Useful for giving permissions, executing kit commands, or running custom scripts.

commands:
  - "give {player} diamond 1"
  - "lp user {player} permission set vip.true"
  - "broadcast {player} bought a VIP rank!"

The category ID this item belongs to. Automatically set when the item is added to a category. Generally should not be changed manually.

Adds an enchantment glint effect to the item without actually enchanting it. Uses a hidden Unbreaking I enchantment. Useful for highlighting special or featured items.

glow: true   # Item will have enchantment shimmer
glow: false  # Normal appearance

For PLAYER_HEAD items, specifies the direct URL to a Minecraft skin texture. The texture will be applied to the head item.

material: "PLAYER_HEAD"
textureUrl: "http://textures.minecraft.net/texture/..."

For PLAYER_HEAD items, sets the owner to a specific player's skin. The head will display that player's skin texture. Alternative to textureUrl for using actual player skins.

material: "PLAYER_HEAD"
skullOwner: "Notch"  # Will display Notch's skin

Regular enchantments applied to the item when purchased. These are standard item enchantments (not stored in books). Use Bukkit enchantment names as keys.

enchantments:
  SHARPNESS: 5
  FIRE_ASPECT: 2
  LOOTING: 3

Hide specific item attributes from the tooltip. Useful for hiding enchantments (when using glow), attributes, or other vanilla item information.

itemFlags:
  - "HIDE_ENCHANTS"
  - "HIDE_ATTRIBUTES"
  - "HIDE_UNBREAKABLE"

Custom NBT data stored in the item's PersistentDataContainer. Useful for plugin integration or tracking items. Keys are stored under the EssentialsC namespace.

nbtData:
  shop_item_id: "special_sword_001"
  tier: "legendary"

When set to true, this item becomes a monster spawner. The material will automatically be set to SPAWNER if not already. Use with spawnerType to specify the entity.

spawner: true
spawnerType: "ZOMBIE"  # Creates a Zombie Spawner

The entity type for spawner items. Must be a valid Bukkit EntityType. Common values: ZOMBIE, SKELETON, SPIDER, CAVE_SPIDER, BLAZE, CREEPER, etc. Defaults to PIG if invalid.

spawner: true
spawnerType: "BLAZE"      # Blaze spawner
spawnerType: "WITHER"     # Wither spawner
spawnerType: "ENDERMAN"   # Enderman spawner

When set to true, this item becomes an enchanted book. The material will automatically be set to ENCHANTED_BOOK. Use with storedEnchantments to define the enchantments stored in the book.

enchantedBook: true
storedEnchantments:
  MENDING: 1
  UNBREAKING: 3

Enchantments stored in an enchanted book. These are different from regular enchantments - they are stored in the book and can be applied to items via anvil. Only used when enchantedBook is true.

enchantedBook: true
storedEnchantments:
  SHARPNESS: 5
  LOOTING: 3
  SWEEPING_EDGE: 3