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

#
# GsFriends settings — restart after changing timing settings.
# Text and colors: messages.yml | Reload: /gsfriends 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: GsFriends
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◆'
friends:
  default-limit: 50
  maximum-limit: 250
  request-lifetime-hours: 48
  join-notifications: true

messages.yml

#
# GsFriends messages — edit the quoted text, keep the keys.
# Reload: /gsfriends 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: {}
boss-bar: {}
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:
    friend-add-accept-deny-remove-player: /friend add|accept|deny|remove <player>
    friend-request-declined: Friend request declined.
    is-online: '{player} is online.'
  friend-service:
    your-friend-limit-is-reached: Your friend limit is reached.
    you-already-have-20-pending-requests: You already have 20 pending requests.
    that-player-is-not-available: that player is not available.
    you-are-already-friends-with-that-player: you are already friends with that player.
    a-friend-request-is-already-pending: a friend request is already pending.
    a-friend-request-was-sent-to: a friend request was sent to {player}.
    sent-you-a-friend-request-use-friend: '{player} sent you a friend request. Use /friend accept {player2}.'
    no-matching-friend-request-was-found: no matching friend request was found.
    you-are-now-friends-with: you are now friends with {detail}.
    accepted-your-friend-request: '{player} accepted your friend request.'
    that-player-was-not-found: that player was not found.
    the-friend-was-removed-and-any-access: the friend was removed and any access you gave them was revoked.
    that-player-is-not-on-your-friends: that player is not on your friends list.
  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}'
overrides: {}