Getting started

Installation

Requirements#

  • Spigot, Paper or a fork, 1.17 or newer (the plugin declares api-version: 1.17).
  • Java 17 or newer.
  • A Tebex store and its game server secret key.
  • PlaceholderAPI is optional and only needed for placeholders.

Install#

  1. Put HyperCredits-1.0.7.jar in your server's plugins/ folder.
  2. Restart the server. Do not use /reload.
  3. Open plugins/HyperCredits/config.yml and set tebex.secret-key. In your Tebex dashboard it is under Integrations, Game Servers, edit your server, Secret Key.
  4. Run /hc reload, then /hc status. The status page shows the mode, the Tebex connection and how many packages were loaded.
First start

Admins with hypercredits.admin get a chat reminder when they join if the secret key is still not set.

Files created in plugins/HyperCredits/:

FileWhat it holds
config.ymlTebex key, server info, coupon and gift card defaults, trading, instant claim, confirmation, updater.
templates.ymlThe look and effects of every voucher template (10 included).
messages.ymlEvery message the plugin sends.
discord.ymlDiscord webhook logging.
gui/*.ymlThe five menus: claim, confirm, history, trade and vouchers.
data.yml, redeemed.ymlPlayer voucher data and the list of already redeemed voucher IDs (the anti-dupe list).