Configuration reference

These are the bundled defaults. Edit your installed files, not this page. Expand only the file you need.

Back up before editing. Keep YAML indentation; quote text with # or &. Missing default settings and messages are added on reload while your values are preserved. Restart after scheduler timing changes.

Default files

config.yml

#
# GsHomes settings — restart after changing timing settings.
# Text and colors: messages.yml | Reload: /gshomes reload
# icons.chat.mode: auto = item icon, text = symbol, off = no icon.
# Texture examples: minecraft:item/diamond, minecraft:item/emerald, minecraft:block/spawner.
# feedback.boss-bars is optional; messages and countdown text are in messages.yml.
brand: GsHomes
feedback:
  sounds: true
  particles: true
  titles: true
  action-bars: true
  chat: true
  boss-bars: false
  boss-bar-seconds: 3
  boss-bar-color: YELLOW
  boss-bar-style: PROGRESS
icons:
  mode: auto
  chat:
    mode: auto
    texture: minecraft:item/gold_ingot
    text: '&#F5C451◆'
homes:
  default-limit: 3
  maximum-limit: 100
  teleport-cost: 0.0
teleportation:
  combat-tag-seconds: 15
  combat-bar: true
  warmup-seconds: 5
  staff-bypass: true
  home-cooldown-seconds: 5
  tpa-request-lifetime-seconds: 60
  tpa-request-cooldown-seconds: 10
  punish-combat-logging: false
  tpa-menu-for-friends-only: false

messages.yml

#
# GsHomes messages — edit the quoted text, keep the keys.
# Reload: /gshomes reload
# Colors: '&aGreen', '&#F5C451Gold', '#F5C451Gold', '<#F5C451>Gold', '§aGreen'.
# Keep placeholders such as {amount}; their values come from the plugin.
# Use an empty string '' to hide an individual message. Icons are in config.yml.
# format = layout; action-bar/boss-bar = live status; messages = chat feedback.
# overrides preserves older custom overrides; new setups use readable keys below.
format:
  prefix: '{icon} &#F5C451{brand} &8› '
  chat: '{prefix}{tone} &f{message}'
  action-bar: '{message}'
  boss-bar: '{message}'
  tones:
    success: '&a✓'
    error: '&c!'
    warning: '&e!'
    info: '&b➜'
    denied: '&d!'
action-bar:
  teleport: '&7Teleport to &f{destination} &8· &b{seconds}s &8· &7Do not move'
  teleport-bypass: '&aTeleporting to {destination} &7(staff bypass)'
  teleport-complete: '&aTeleporting to {destination}'
  teleport-cancelled: '&cTeleport cancelled: {reason}'
  combat: '&c⚔ In combat &f{opponent} &7{health} HP &8· &e{seconds}s'
  combat-ended: '&a✓ Out of combat'
boss-bar:
  teleport: '&fTeleport to {destination} &8· &e{seconds}s'
  combat: '&cIn combat with {opponent} &8· &f{seconds}s'
messages:
  gs-plugin:
    admin-permission-required: admin permission required.
  golden-menu-listener:
    that-menu-action-failed-check-your-balance: that menu action failed. Check your balance or inventory before
      retrying.
  prompts:
    type-in-chat-or-cancel-expires-in: '{question} — type in chat, or ''cancel''. Expires in 60s.'
    input-cancelled: Input cancelled.
    input-is-limited-to-160-characters: Input is limited to 160 characters.
    the-action-failed-contact-an-administrator: The action failed. Contact an administrator.
  main:
    invalid-or-already-used-home-name: Invalid or already used home name.
    invalid-item-material: Invalid item material.
    home-saved: Home saved.
    invalid-name-or-home-limit-reached: Invalid name or home limit reached.
    home-deleted: Home deleted.
    home-not-found: Home not found.
  teleport:
    in-combat: you cannot teleport to {destination} during combat. Wait {remaining}s.
    already-pending: you already have a teleport counting down.
    cancelled: 'your teleport was cancelled: {reason}.'
  home-service:
    a-home-teleport-costs-coins-and-you: a home teleport costs {cost} coins and you have {detail}.
    you-do-not-have-a-home-with: you do not have a home with that name.
    the-world-is-not-loaded-so-this: the world "{detail}" is not loaded, so this home cannot be reached yet.
    wait-s-before-teleporting-again: wait {detail}s before teleporting again.
    that-home-no-longer-exists: that home no longer exists.
    the-world-is-not-loaded-so-that: the world "{detail}" is not loaded, so that home cannot be reached yet.
    you-no-longer-have-the-coins-for: you no longer have the {cost} coins for that.
    teleported-paid: 'Teleported to {name} for {cost} coins.'
    teleported: 'Teleported to {name}.'
    the-home-teleport-failed-your-refund-was: the home teleport failed. Your refund was queued and your cooldown
      was reset.
  admin:
    reloaded: '&aSettings and messages reloaded.'
    usage: /{command} admin | setbrand <name> | set <key> <value> | reload | audit
    permission: '&cYou need {permission}.'
    brand-updated: Brand updated to {brand}.
    setting-updated: Updated {setting}.
    console: Use setbrand, set, reload or audit from console.
    audit-empty: No uncertain payments awaiting review.
    audit-results: '{entries}'
  errors:
    detail: '&c{detail}'
    action-failed: '&cThe action failed. Check your balance before retrying or contact staff.'
  license:
    pending: 'Activation pending. Use /{command} license status. Support: https://discord.gg/QPYeUjBxYe'
    status: '{status}

      Installation: {installation}

      Support: {support}'
reasons:
  moved: 'you moved'
  damage: 'you took damage'
overrides: {}