Configuration reference
This is the config.yml SmartHomes 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, limits, warmup, cooldown, vault, homes-gui, home-options-gui, back.
# ──────────────────────────────────────────────────────────────────────────────
# SmartHomes — config.yml
# by TTS-Studio · MiniMessage formatting throughout · all values hot-reloadable
# via /sh reload (warmups in flight finish on their original timing).
# ──────────────────────────────────────────────────────────────────────────────
# ─── 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/SmartHomes/lang/.
language: en
# ─── Limits ───────────────────────────────────────────────────────────────────
# How many homes a player can have. The actual limit is the highest
# `smarthomes.limit.<n>` permission they hold, falling back to `default`.
limits:
default: 3 # baseline when no smarthomes.limit.<n> is granted
# ─── Warmup ───────────────────────────────────────────────────────────────────
# Brief countdown before the teleport actually happens. Cancels on movement
# or damage. Players with `smarthomes.bypass.warmup` skip it.
warmup:
enabled: true # set false to teleport instantly
seconds: 3 # countdown length
# ─── Cooldown ─────────────────────────────────────────────────────────────────
# Time between successive /home uses. Cleared on disconnect.
# Players with `smarthomes.bypass.cooldown` skip it.
cooldown:
enabled: true
default-seconds: 300 # 5 minutes
# ─── Vault economy ────────────────────────────────────────────────────────────
# Optional per-teleport cost. Requires Vault + a Vault-compatible economy
# plugin. Players with `smarthomes.bypass.cost` are not charged.
vault:
enabled: false # toggle to charge per teleport
cost-per-use: 100.0 # currency per /home use
# ─── GUI — /homes ─────────────────────────────────────────────────────────────
# Visual customization for the paginated homes browser.
# title and fill-material are reserved for back-compat; the v1.1 GUI now uses
# the unified TTS-Studio palette (green #6FCF7E) and a perimeter filler.
homes-gui:
title: "<dark_aqua>Your Homes" # back-compat, unused in v1.1+
fill-empty-slots: true # back-compat, unused in v1.1+
fill-material: GRAY_STAINED_GLASS_PANE # back-compat, unused in v1.1+
# ─── GUI — per-home options ───────────────────────────────────────────────────
home-options-gui:
title: "<dark_aqua>Home Options" # back-compat, unused in v1.1+
# ─── /back ────────────────────────────────────────────────────────────────────
# Returns the player to their last teleport-from location.
# Warmup, cooldown, and Vault cost apply the same as /home.
back:
enabled: true # false disables the /back command entirely
clear-on-death: false # true removes the saved location when the player dies