Skip to content
◆ TTS-STUDIO docs Discord

Plugins / TradeForge

Configuration reference

This is the config.yml TradeForge 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, trade, money, extra-currencies, experience, log, debug.

# TradeForge — player-to-player trading.
#
# Every message lives in lang/<language>.yml. Everything that decides what is
# allowed lives here.

language: en

# Your licence key, from the store where you bought TradeForge. Required: without it
# TradeForge switches itself off. BuiltByBit downloads already carry theirs, so leave it
# blank there. Checked in the background at startup and every six hours; if the
# licence server cannot be reached, TradeForge keeps running.
license-key: ""

trade:
  # Seconds a request waits before it expires on its own.
  request-timeout: 60

  # How far apart two traders may stand, in blocks. 0 = no limit.
  # Measured again on every settlement: walking away mid-trade cancels it.
  max-distance: 15

  # Slots each side may fill. 12 is three rows of four on each half.
  slots-per-side: 12

  # Both sides must confirm, and any change to either offer clears BOTH
  # confirmations. That is what stops the swap-at-the-last-moment scam, and it
  # is not optional: there is no setting here to weaken it.

  # Materials that cannot be put on the table, by name. Anyone with
  # tradeforge.bypass.blocked ignores this.
  blocked-materials: []

  # Refuse to start a trade while either player is in combat. Needs a plugin
  # that marks combat through the metadata key below; ignored when absent.
  block-in-combat: true
  combat-metadata-key: "in-combat"

money:
  # Put money on the table alongside items.
  enabled: true
  # What the money button trades:
  #   vault             Vault money (EssentialsX, CMI, ... behind it)
  #   playerpoints      PlayerPoints
  #   tokenmanager      TokenManager tokens
  #   coinsengine:<id>  one currency of ExcellentEconomy / CoinsEngine
  currency: vault
  # Largest amount a single trade may carry. 0 = no limit.
  max-amount: 0

# Up to two more currencies on the table, each with its own button next to the
# experience one. Same names as money.currency. Players click the button
# (+1 / -1, shift x10) or type /trade offer <currency> <amount>. Every currency
# moves in the same all-or-nothing step: if one payment is refused, the others
# are given back and the trade stays open.
extra-currencies: []
#  - currency: playerpoints
#    icon: AMETHYST_SHARD
#    name: "Points"
#    max-amount: 0

experience:
  # Put experience levels on the table. The giver loses the levels and keeps their
  # progress bar; the receiver gets the exact experience points those levels were
  # worth, so nothing is created or lost (five levels at 40 are worth far more than
  # five at 0). Nothing leaves the giver until the trade closes.
  enabled: true
  # Most levels a single side may offer. 0 = no limit.
  max-levels: 0

log:
  # Every settled trade is appended to plugins/TradeForge/trades.log, which is
  # tab separated so you can grep it. This is how many of them are kept in
  # memory for /trade log, and how many are read back from the file on start.
  keep-last: 200
  # Also write each settled trade to the server console.
  to-console: false

debug:
  # Anonymous usage stats at bstats.org. Turn it off on an offline network.
  bstats: true

Keep reading