Getting started

Installation and requirements

Requirements#

  • Paper 1.21 or newer (the plugin uses api-version 1.21).
  • Java 21.
  • A Tebex store, and its secret key from creator.tebex.io.
  • The official Tebex plugin, to deliver purchases.
  • PlaceholderAPI is optional and only needed for the placeholders.

Install#

  1. Put the jar in plugins/ and start the server. With no key set, the plugin still enables and logs one warning.
  2. Go to creator.tebex.io, Integrations, Game Servers, open your server and copy the Secret Key.
  3. Run /hypertebex key <secret_key>. The key is saved, the store is synced and the data is cached to cache/store_data.json.
  4. Run /store to test.
Set the key from the console

Running the key command from the server console keeps the key out of in-game chat history. Anyone with the key can read your store data, so keep it private. You can also paste it into tebex_secret_key in config.yml and run /ht reload.

Files in plugins/HyperTebex/#

FileWhat it is
config.ymlKey, sync, price formats, purchase flow, cart, sounds, permissions.
guis.ymlEvery menu: title, size, slots, items, navigation and static items.
messages.ymlEvery message players and admins see.
store_data.ymlPer-category and per-package settings. Filled in automatically after each sync.
store_ids.txtEvery category and package with its ID. Rewritten after each sync.
cache/store_data.jsonLast successful sync. Written by the plugin, so the store opens even if Tebex is down.
cache/carts.jsonSaved player carts. Written by the plugin.