Reference

Configuration

The main settings are in config.yml. Apply changes with /ht reload, no restart needed. Colors work everywhere: legacy &a, hex &#RRGGBB and MiniMessage.

Key and API#

tebex_secret_key: ""

# Base URL of the Tebex Plugin API. Only change this if Tebex tells you to.
tebex_api_url: "https://plugin.tebex.io"

developer-settings:
  # Verify Tebex's SSL certificate. Only disable this for debugging behind broken proxies!
  verify-ssl: true
  # Timeout for every Tebex request.
  api-timeout-seconds: 10

Prices and dates#

# Overrides the currency symbol supplied by Tebex (e.g. "$", "€", "£"). Leave blank to use Tebex's.
currency_symbol_override: ""

# java.text.DecimalFormat pattern used for every price.
price_format: "#,##0.00"

# java.text.SimpleDateFormat pattern used for sale end dates and the last-sync time.
date_format: "MM/dd/yyyy HH:mm z"
# Time zone used for dates, e.g. "America/New_York" or "UTC". Blank = the server's time zone.
timezone: ""

Price display#

price_display:
  on_sale: "&c&m%currency_symbol%%original_price%&r &a&l%currency_symbol%%sale_price% &e(-%discount_percent%%)"
  not_on_sale: "&a%currency_symbol%%price%"
  # Use %original_price_if_on_sale% in a package lore line to show this ONLY when the package is on sale.
  original_price_if_on_sale: "&7Was: &c&m%currency_symbol%%original_price%"
  # Shown instead of a price for free (0.00) packages.
  free: "&a&lFREE"

Available here: %currency_symbol%, %price%, %original_price%, %sale_price%, %discount%, %discount_percent%.

Descriptions#

# Package/category descriptions are stripped of HTML and word-wrapped to this many characters per line.
max_description_length_per_line: 40
# Maximum number of description lines shown in an item's lore (0 = unlimited).
max_description_lines: 6

GUI behavior and sounds#

gui:
  # Hide categories that have no packages (and no non-empty sub-categories).
  remove_empty_categories: true
  # true  = main menu only shows root categories; sub-categories open in their own menu.
  # false = every category (including sub-categories) is listed in the main menu.
  display_parent_categories_only: true
  # How often (seconds) open GUIs are refreshed so %sale_time_left% counts down live. 0 = disabled.
  title_refresh_seconds: 1
  # Re-render open store GUIs after a successful sync so players see new data immediately.
  refresh_on_sync: true
  # Minimum milliseconds between handled GUI clicks (prevents double-click spam).
  click_cooldown_ms: 150
  sound:
    enabled: true
    open: "block.chest.open:0.4:1.2"
    click: "ui.button.click:0.5:1.0"
    success: "entity.player.levelup:0.6:1.6"
    error: "entity.villager.no:0.7:1.0"

Sounds use the form "key:volume:pitch". Leave one blank to disable just that sound. The decorative border and fill-empty-slots options are in guis.yml under gui_settings.

Recent purchases#

recent_payments:
  enabled: true
  limit: 5

Feeds %hypertebex_recent_purchaser_<1-N>% and %hypertebex_recent_purchase_amount_<1-N>% from Tebex's payments list.

Debugging#

debug_mode: false

Set to true to print requests, timings and parse warnings to the console.