Reference

Configuration

The main file is plugins/HyperCredits/config.yml. Run /hc reload after editing it.

Tebex and server#

tebex:
  secret-key: "YOUR_SECRET_KEY"
  # Seconds to wait for Tebex before giving up (the voucher is returned on failure)
  timeout-seconds: 15

server:
  name: "My Server"
  store-link: "https://your-store-link.com"
  ip: "play.yourserver.com"

# Symbol used for gift card amounts and value coupons
currency-symbol: "$"
# Date format used in GUIs and messages (Java SimpleDateFormat)
date-format: "dd/MM/yyyy"

Gift cards and coupons#

giftcard-settings:
  # {player} = who redeemed it
  note: "HyperCredits gift card for {player}"

coupon-settings:
  # "percentage" or "value" (can be overridden per voucher with discount:value)
  discount_type: "percentage"
  note: "Created via HyperCredits for {player}"
  # Prefix for generated coupon codes
  code-prefix: "HC-"
  # single, subscription or both
  basket-type: "both"
  # 0 = discount each package, 1 = discount basket before sales, 2 = discount basket after sales
  discount-application-method: 0
  # Minimum basket value required to use the coupon (0 = none)
  minimum-basket: 0
  # Lock the coupon to the Minecraft username of the player who redeemed it
  lock-to-player: false

Behavior#

trade-vouchers: true
drop-trade: false
instant-claim: false
remove-expired-vouchers: true

redeem-confirmation:
  enabled: true
  # vouchers worth this much or less skip the confirmation (0 = always confirm)
  skip-threshold: 0.0

# Print every Tebex request/response to console (secret key is never printed)
debug: false

Updater#

updater:
  enabled: true
  check-on-startup: true
  check-interval-hours: 24
  # Download new versions into plugins/update/. They install on the next restart.
  # The current jar is backed up to plugins/HyperCredits/backup/ first.
  auto-download: false
  # Tell the console and admins (hypercredits.admin) about updates
  notify: true
  # Leave blank to use the built-in token
  shared-token: ""
  # 0 = HyperCredits (69795)
  resource-id: 0