Using it

Subscriptions, ranks and conditions

Subscriptions#

A subscription item charges again every interval until the player cancels or cannot pay:

    subscription:
      enabled: true
      interval: 30d
      # Runs on each renewal.
      renew-commands: []
    # Runs when the subscription ends.
    decline-subscription-commands:
      - "lp user %player% parent remove vip"
  • The first purchase starts the subscription. Every interval the player is charged again and renew-commands run.
  • When the player cancels, or cannot pay, the subscription ends and decline-subscription-commands run (for example to remove the rank).
  • If the player is offline when it ends, they get a note when they next join.
  • Players manage subscriptions in /coinshop subscriptions. Cancelling stops the renewal but keeps the item until the paid time runs out, and it can be resumed.
  • Subscriptions are checked every subscription.check-interval-seconds seconds (default 60). They are saved in data/subscriptions.yml.
  • Renew and decline commands use %player% (the player's name).

Rank ladders and conditions#

requires:
  items: [ranks.vip]
  conditions: ["%player_level% >= 10"]

requires.items makes an item need an earlier purchase of those items. requires.conditions are comparisons that use >=, <=, >, <, == or !=. Numbers compare as numbers and anything else as text. PlaceholderAPI placeholders in conditions need PlaceholderAPI installed.

Permissions on items#

  • permission: some.node needs that node to buy.
  • permission-mode: purchase (default) shows the item but blocks buying. permission-mode: view hides the item from players without the permission.

Timed release#

previewing: {enabled: true, publish-date: "2030-01-01 12:00:00"} shows the item but blocks buying until the date. Use an absolute date.