Using it

Buying, gifts and the claim box

The confirm screen#

When a player clicks an item, a confirm screen opens (when shop.confirm-purchases is on and the item does not set confirm: false). It has quantity buttons, a Reset button and a Buy The Most button. It shows what the player gets, the full price and the balance. A coupon can be entered there when shop.coupons-enabled is on.

Why a purchase can fail#

  • Not enough currency, or the currency does not exist.
  • Out of stock (bypass: coinshop.bypass.stock).
  • The per-player limit is reached (bypass: coinshop.bypass.limit).
  • The item's cooldown has not passed (bypass: coinshop.bypass.cooldown).
  • The item needs a permission, an earlier purchase or a condition the player does not meet.
  • The item has a future previewing.publish-date.
  • The player already has that subscription.

Stock only changes after payment succeeds. Players with coinshop.free get every item for free.

Gifting#

/coinshop gift <player> opens the shop in gift mode (online or offline players, needs coinshop.gift). The buyer pays and the receiver gets the item. Set giftable: false on an item to hide it from gifting. In commands, %buyer% is the payer.

Claim box#

Gifts and rewards that do not fit in an inventory wait in the claim box. Players open it with /coinshop claim, with a Claim All button that collects as much as fits. shop.full-inventory is QUEUE (keep it for the claim box) or DROP (drop it at the player's feet). With shop.claim-on-join: true, waiting gifts are handed over when the player joins.

History, search and subscriptions#

  • /coinshop history lists past purchases (up to gui.history-size).
  • /coinshop search <text> finds items by name.
  • /coinshop subscriptions lets players see, cancel and resume subscriptions.
shop:
  # Shows the confirm screen with quantity and coupon. Items can override this with "confirm: false".
  confirm-purchases: true
  coupons-enabled: true
  # When a reward does not fit: QUEUE keeps it for /coinshop claim, DROP drops it at the player's feet.
  full-inventory: QUEUE
  # Hands over waiting gifts and rewards when a player joins.
  claim-on-join: true
  # Tells everyone in chat about each purchase.
  announce-purchases: false
  announce-restocks: true
  # Webhook warning when stock falls to this number.
  low-stock-warning: 5
  sounds:
    open-sound: ui.button.click
    purchase-sound: entity.experience_orb.pickup
    error-sound: entity.villager.no
    sale-start: entity.player.levelup
    sale-end: block.note_block.bass
    sale-join: entity.experience_orb.pickup