Configuration reference

This is the config.yml ShopForge writes on first start, comments included. Every key you see here is the key the plugin reads; there are no hidden ones. Change a value, reload, and it applies.

Top-level sections: language, license-key, shop, stock-refill-task-interval-minutes, confirm-gui-threshold.

# =============================================================================
#                        ShopForge — main configuration
# =============================================================================
# Edit this file then run /shopforge reload (or restart the server) to apply.
# All keys below correspond to options actually consumed by the plugin code;
# adding extra keys here won't change behaviour.
# =============================================================================


# ===== Language =====
# Active language. ISO-639-1 two-letter code (lowercase).
# Bundled out of the box: es (Spanish), en (English).
# Missing keys fall back to en automatically. Operators can drop extra
# lang/<code>.yml files in plugins/ShopForge/lang/.
language: en


# ===== Licensing =====
# License key issued by TTS Studio. Leave blank for the free tier.
# Premium features (advanced categories, extended logs) check this value at
# startup. An invalid or missing key falls back gracefully — the plugin still
# loads, but premium gates will refuse.
license-key: ""


# ===== Shop display =====
shop:
  # How prices are rendered in GUIs and chat messages.
  # Standard Java printf-style format. The single %f is the amount.
  # Examples:
  #   "$%.2f"      ->  $1234.50
  #   "%.0f coins" ->  1234 coins
  #   "%,.2f$"     ->  1,234.50$
  currency-format: "$%.2f"

  # How many transaction-log entries fit on one page when a player runs
  # /shop log. Lower this if your chat is cramped, raise it for power users.
  log-page-size: 10


# ===== Stock =====
# How often (in minutes) the background task wakes up to refill per-player
# stock counters whose `stock-refill-hours` window has elapsed. Lower values
# = snappier refills but more DB hits; higher values = laggier refills but
# lighter load. 5 is a sane default for most servers.
stock-refill-task-interval-minutes: 5


# ===== Transactions =====
# When a player tries to buy >= this many items in one transaction, ShopForge
# opens a ConfirmGui asking them to confirm before deducting money. This
# protects against fat-finger mistakes on bulk purchases.
# Set to 0 to disable confirmation entirely.
# Default: 64 (one full stack)
confirm-gui-threshold: 64