Using it

Credits, economy and the webstore

Where credits are kept#

economy.provider chooses the balance that counts toward release:

  • internal: mcBans' own counter, separate from your economy. This is the default and needs no other plugin.
  • vault: the player's Vault economy balance.
  • playerpoints: the player's PlayerPoints balance.
  • coinsengine: a CoinsEngine currency, named by economy.coinsengine-currency.

With an external provider, the threshold is taken from the balance on release, and pickaxe upgrades are paid from the same balance.

economy:
  provider: internal
  coinsengine-currency: "coins"

Admin commands#

All need mcbans.purgatory.admin and work on offline players:

  • /purgatory give <player> <credits> and /purgatory take <player> <credits>.
  • /purgatory setpickaxe <player> <tier> sets their pickaxe tier.
  • /purgatory status <player> shows credits, lifetime credits, ore mined, tier and the active purgatory ban.
  • /purgatory reset <player> resets their purgatory progress.

Selling credits#

Players open the credit store from the pickaxe menu (right-click the pickaxe, then Buy credits) or with /purgatory store. Clicking a package sends a clickable link to your webstore. mcBans does not take payments itself.

store:
  enabled: true
  url: "https://store.example.com"
  packages:
    pouch:
      name: "<white>Pickaxe Pouch"
      credits: 1000
      price: "$2.99"
      icon: GOLD_NUGGET
      url: ""            # empty = the main store url above

In your webstore (Tebex or similar), make each package run this console command after purchase:

purgatory give {username} 5000

It works while the player is offline or on another server. The player must have joined at least once, or use their UUID instead of the name. If the new balance reaches purgatory.unban-threshold, they are released right away.

Match the package credits

The credits shown in game come from store.packages, but the credits actually given come from your webstore command. Keep the two in sync.