Default gui.yml

Last updated Oct 28, 2026

Default gui.yml

Shipped defaults from SoapsArena 1.0.1. After first run, this file lives in plugins/SoapsArena/.

Updating the jar does not overwrite your live copy. Use this page to compare or reset.

See also: Config Reference · GUI Menus

# ============================================
#       SoapsArena GUI Configuration
# ============================================
#
# Suite GUI: config.yml -> gui.enabled is the master kill-switch for this plugin's
# inventory UIs. This file defines menu layout (titles, sizes, items).
# Text uses MiniMessage.
# SoapsAdmin uses a gui/ folder for many menus (advanced suite layout).
#
# All text supports MiniMessage format.
# Placeholders: {player}, {arenas_available}, {in_game},
#   {current_room}, {total_kills}, {total_deaths}, {total_wins},
#   {duel_wins}, {win_streak}, {best_win_streak}, {kdr},
#   {room}, {players}, {max_players}, {status}, {mode},
#   {time_limit}, {fall_damage}, {hunger},
#   {tab}, {rank}, {value}, {page}
#
# Actions:
#   [close]                  - Close the GUI
#   [open_menu] <id>         - Open another menu (main_hub, arena_browser,
#                              stats, admin, leaderboards, leaderboard_view)
#   [command] <cmd>          - Player runs /<cmd> (supports placeholders)
#   [prev_page]              - Previous page (paginated GUIs)
#   [next_page]              - Next page (paginated GUIs)
#   [refresh]                - Refresh current GUI
#   [join_random]            - Join a random available arena
#   [leave_game]             - Leave current game
#   [help]                   - Show help commands
#   [reload]                 - Reload plugin configuration
#   [tab] kills              - Switch to kills tab (leaderboard)
#   [tab] wins               - Switch to wins tab (leaderboard)
#   [tab] streak             - Switch to streak tab (leaderboard)
#   [feedback] <msg-key>     - Send a message without closing the GUI
#   [none]                   - No action (decorative item)
#
# Slot numbers start at 0. Multi-slot: "0,1,2"
# permission: soapsarena.some.perm  - item only shown/clickable with permission
# ============================================

settings:
  # Enable or disable all GUI panels (true/false)
  enabled: true
  # Material used to fill empty slots in all GUIs
  filler-material: GRAY_STAINED_GLASS_PANE
  filler-name: " "
  # Sound played on GUI open (set to NONE to disable)
  open-sound: BLOCK_CHEST_OPEN
  open-sound-volume: 0.7
  open-sound-pitch: 1.2
  # Sound played on GUI click (set to NONE to disable)
  click-sound: UI_BUTTON_CLICK
  click-sound-volume: 0.5
  click-sound-pitch: 1.0

# ============================================
#               Menu Definitions
# ============================================
menus:

  # ------------------------------------------
  #          Main Hub
  # ------------------------------------------
  main-hub:
    title: "<gradient:#FF6B35:#FFD700><bold>⚔ SoapsArena Hub</bold></gradient>"
    size: 5
    items:
      # ── Border ──
      border:
        slot: "0,1,2,3,4,5,6,7,8,9,17,18,26,27,35,36,37,38,39,40,41,42,43,44"
        material: GRAY_STAINED_GLASS_PANE
        name: " "

      # ── Background fill ──
      background:
        slot: "10,12,14,16,19,21,23,25,30,32"
        material: LIGHT_GRAY_STAINED_GLASS_PANE
        name: " "

      # ── Action items ──
      leaderboards:
        slot: 11
        material: GOLD_INGOT
        name: "<gradient:#FFD700:#FF6B35><bold>🏆 Leaderboards</bold></gradient>"
        lore:
          - ""
          - "<gray>View top players across"
          - "<gray>all arenas and stats."
          - ""
          - "<gradient:#FF6B35:#FFD700>Open leaderboards</gradient>"
        action: "[open_menu] leaderboards"

      stats:
        slot: 13
        material: PLAYER_HEAD
        name: "<gradient:#3b82f6:#60a5fa><bold>📊 Your Stats</bold></gradient>"
        lore:
          - ""
          - "<gray>Kills: <yellow>{total_kills}"
          - "<gray>Deaths: <yellow>{total_deaths}"
          - "<gray>K/D: <yellow>{kdr}"
          - ""
          - "<gradient:#FF6B35:#FFD700>View stats</gradient>"
        action: "[open_menu] player-stats"

      help:
        slot: 15
        material: BOOK
        name: "<gradient:#FF6B35:#FFD700><bold>📖 Commands</bold></gradient>"
        lore:
          - ""
          - "<gray>List available commands"
          - "<gray>and how to use them."
          - ""
          - "<gradient:#FF6B35:#FFD700>Show commands</gradient>"
        action: "[help]"

      join_random:
        slot: 20
        material: EMERALD
        name: "<gradient:#10b981:#34d399><bold>⚡ Quick Join</bold></gradient>"
        lore:
          - ""
          - "<gray>Queue for the best"
          - "<gray>available arena room."
          - ""
          - "<gradient:#FF6B35:#FFD700>Quick join</gradient>"
        action: "[join_random]"

      browse_arenas:
        slot: 22
        material: COMPASS
        name: "<gradient:#06b6d4:#3b82f6><bold>🗺 Arena Browser</bold></gradient>"
        lore:
          - ""
          - "<gray>Browse rooms and"
          - "<gray>choose one to queue for."
          - ""
          - "<yellow>Arenas: <gold>{arenas_available}"
          - ""
          - "<gradient:#FF6B35:#FFD700>Browse rooms</gradient>"
        action: "[open_menu] arena_browser"

      current_session:
        slot: 24
        material: NETHER_STAR
        name: "<gradient:#a855f7:#c084fc><bold>📍 Session Status</bold></gradient>"
        lore:
          - ""
          - "<gray>Player: <white>{player}"
          - "<gray>In Game: <white>{in_game}"
          - "<gray>Room: <white>{current_room}"
          - ""
          - "<#9ca3af>Your current queue or match."
        action: "[none]"

      admin_control:
        slot: 29
        material: REDSTONE_TORCH
        name: "<gradient:#ef4444:#dc2626><bold>🛠 Admin Control</bold></gradient>"
        lore:
          - ""
          - "<gray>Open the admin panel for"
          - "<gray>arena management."
          - ""
          - "<red>Requires permission</red>"
        permission: soapsarena.admin
        action: "[open_menu] admin-control"

      leave_game:
        slot: 31
        material: RED_BED
        name: "<gradient:#ef4444:#dc2626><bold>🚪 Leave Game</bold></gradient>"
        lore:
          - ""
          - "<gray>Leave your current match"
          - "<gray>or leave the queue."
          - ""
          - "<gradient:#FF6B35:#FFD700>Leave match</gradient>"
        action: "[leave_game]"

      duel:
        slot: 33
        material: DIAMOND_SWORD
        name: "<gradient:#ef4444:#f97316><bold>⚔ Duel Info</bold></gradient>"
        lore:
          - ""
          - "<gray>Challenge players to duels"
          - "<gray>using <yellow>/sar duel <player>"
          - ""
          - "<gray>Duel Wins: <gold>{duel_wins}"
        action: "[none]"

      close:
        slot: 34
        material: BARRIER
        name: "<gradient:#ef4444:#dc2626><bold>✖ Close</bold></gradient>"
        lore:
          - ""
          - "<gray>Close this menu."
        action: "[close]"


  # ------------------------------------------
  #          Arena Browser (Paginated)
  # ------------------------------------------
  arena-browser:
    title: "<gradient:#06b6d4:#3b82f6><bold>🗺 Arena Browser</bold></gradient>"
    size: 6

    arena-slots:
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 25
      - 28
      - 29
      - 30
      - 31
      - 32
      - 33
      - 34

    arena-item:
      material-available: LIME_STAINED_GLASS_PANE
      material-waiting: YELLOW_STAINED_GLASS_PANE
      material-active: RED_STAINED_GLASS_PANE
      material-disabled: BARRIER
      name: "<gradient:#FF6B35:#FFD700><bold>{room}</bold></gradient>"
      lore:
        - ""
        - "<gray>Players: <white>{players}<gray>/<white>{max_players}"
        - "<gray>Status: <white>{status}"
        - "<gray>Mode: <white>{mode}"
        - "<gray>Time Limit: <white>{time_limit}"
        - ""
        - "{action}"

    items:
      border:
        slot: "0,1,2,3,4,5,6,7,8,9,17,18,26,27,35,36,44,46,47,48,51,52"
        material: GRAY_STAINED_GLASS_PANE
        name: " "

      prev-page:
        slot: 45
        material: ARROW
        name: "<gradient:#FF6B35:#FFD700><bold>◀ Previous</bold></gradient>"
        lore:
          - ""
          - "<gray>Go to previous page"
        action: "[prev_page]"

      page-info:
        slot: 49
        material: PAPER
        name: "<gray>Page <yellow>{page}</yellow>/<yellow>{max_page}"
        action: "[none]"

      back:
        slot: 50
        material: BARRIER
        name: "<gradient:#ef4444:#dc2626><bold>✖ Back</bold></gradient>"
        lore:
          - ""
          - "<gray>Return to main menu"
        action: "[open_menu] main_hub"

      refresh:
        slot: 40
        material: CLOCK
        name: "<gradient:#10b981:#34d399><bold>⟳ Refresh</bold></gradient>"
        lore:
          - ""
          - "<gray>Refresh arena list"
        action: "[refresh]"

      next-page:
        slot: 53
        material: ARROW
        name: "<gradient:#FF6B35:#FFD700><bold>Next ▶</bold></gradient>"
        lore:
          - ""
          - "<gray>Go to next page"
        action: "[next_page]"


  # ------------------------------------------
  #          Player Stats
  # ------------------------------------------
  player-stats:
    title: "<gradient:#3b82f6:#60a5fa><bold>📊 Your Statistics</bold></gradient>"
    size: 5
    items:
      border:
        slot: "0,1,2,3,4,5,6,7,8,9,17,18,26,27,35,36,37,38,39,40,41,42,43,44"
        material: GRAY_STAINED_GLASS_PANE
        name: " "

      background:
        slot: "10,12,14,16,19,21,23,25"
        material: LIGHT_GRAY_STAINED_GLASS_PANE
        name: " "

      kills:
        slot: 11
        material: IRON_SWORD
        name: "<gradient:#ef4444:#dc2626><bold>⚔ Kills</bold></gradient>"
        lore:
          - ""
          - "<gray>Total Kills: <yellow>{total_kills}"
          - "<gray>Across all arenas"
        action: "[none]"

      deaths:
        slot: 13
        material: SKELETON_SKULL
        name: "<gradient:#6b7280:#9ca3af><bold>💀 Deaths</bold></gradient>"
        lore:
          - ""
          - "<gray>Total Deaths: <yellow>{total_deaths}"
          - "<gray>K/D Ratio: <yellow>{kdr}"
        action: "[none]"

      game-wins:
        slot: 15
        material: GOLDEN_APPLE
        name: "<gradient:#10b981:#34d399><bold>🏆 Game Wins</bold></gradient>"
        lore:
          - ""
          - "<gray>Total Wins: <yellow>{total_wins}"
          - "<gray>Duel Wins: <yellow>{duel_wins}"
        action: "[none]"

      win-streak:
        slot: 20
        material: BLAZE_POWDER
        name: "<gradient:#f59e0b:#fbbf24><bold>🔥 Win Streak</bold></gradient>"
        lore:
          - ""
          - "<gray>Current: <yellow>{win_streak}"
          - "<gray>Best: <gold>{best_win_streak}"
        action: "[none]"

      kdr:
        slot: 22
        material: TARGET
        name: "<gradient:#a855f7:#c084fc><bold>📈 K/D Ratio</bold></gradient>"
        lore:
          - ""
          - "<gray>Ratio: <yellow>{kdr}"
          - ""
          - "<gray>Kills: <yellow>{total_kills}"
          - "<gray>Deaths: <yellow>{total_deaths}"
        action: "[none]"

      session-info:
        slot: 24
        material: CLOCK
        name: "<gradient:#06b6d4:#3b82f6><bold>📍 Current Session</bold></gradient>"
        lore:
          - ""
          - "<gray>In Game: <white>{in_game}"
          - "<gray>Room: <white>{current_room}"
        action: "[none]"

      back:
        slot: 33
        material: ARROW
        name: "<gradient:#FF6B35:#FFD700><bold>↩ Back</bold></gradient>"
        lore:
          - ""
          - "<gray>Return to main menu"
        action: "[open_menu] main_hub"

      close:
        slot: 34
        material: BARRIER
        name: "<gradient:#ef4444:#dc2626><bold>✖ Close</bold></gradient>"
        lore:
          - ""
          - "<gray>Close this menu"
        action: "[close]"


  # ------------------------------------------
  #          Admin Control
  # ------------------------------------------
  admin-control:
    title: "<gradient:#ef4444:#dc2626><bold>🛠 Admin Control</bold></gradient>"
    size: 5
    items:
      border:
        slot: "0,1,2,3,4,5,6,7,8,9,17,18,26,27,35,36,37,38,39,40,41,42,43,44"
        material: GRAY_STAINED_GLASS_PANE
        name: " "

      background:
        slot: "10,12,14,16,19,21,23,25"
        material: LIGHT_GRAY_STAINED_GLASS_PANE
        name: " "

      reload:
        slot: 11
        material: LIME_DYE
        name: "<gradient:#10b981:#34d399><bold>⟳ Reload Config</bold></gradient>"
        lore:
          - ""
          - "<gray>Reload all configuration"
          - "<gray>files."
        permission: soapsarena.admin
        action: "[command] sar reload"

      arena-list:
        slot: 13
        material: COMPASS
        name: "<gradient:#06b6d4:#3b82f6><bold>🗺 Arena List</bold></gradient>"
        lore:
          - ""
          - "<gray>View all arena rooms."
        action: "[command] sar list"

      kit-list:
        slot: 20
        material: CHEST
        name: "<gradient:#f59e0b:#fbbf24><bold>📦 Kit List</bold></gradient>"
        lore:
          - ""
          - "<gray>View all saved kits."
        permission: soapsarena.admin
        action: "[command] sar kit list"

      wand:
        slot: 22
        material: BLAZE_ROD
        name: "<gradient:#FF6B35:#FFD700><bold>🪄 Wand Editor</bold></gradient>"
        lore:
          - ""
          - "<gray>Use <yellow>/sar wand <name></yellow>"
          - "<gray>to create new arenas."
          - ""
          - "<gray>Or <yellow>/sar wand edit <room></yellow>"
          - "<gray>to modify existing ones."
          - ""
          - "<gradient:#FF6B35:#FFD700>Show wand help</gradient>"
        permission: soapsarena.admin
        action: "[command] sar wand"

      browse-arenas:
        slot: 24
        material: EMERALD
        name: "<gradient:#10b981:#34d399><bold>⚡ Arena Browser</bold></gradient>"
        lore:
          - ""
          - "<gray>Open the arena browser"
        action: "[open_menu] arena_browser"

      back:
        slot: 33
        material: ARROW
        name: "<gradient:#FF6B35:#FFD700><bold>↩ Back</bold></gradient>"
        lore:
          - ""
          - "<gray>Return to main menu"
        action: "[open_menu] main_hub"

      close:
        slot: 34
        material: BARRIER
        name: "<gradient:#ef4444:#dc2626><bold>✖ Close</bold></gradient>"
        lore:
          - ""
          - "<gray>Close this menu"
        action: "[close]"


  # ------------------------------------------
  #      Leaderboard Category Selector
  # ------------------------------------------
  leaderboards:
    title: "<gradient:#FFD700:#FF6B35><bold>🏆 Leaderboards</bold></gradient>"
    size: 4
    items:
      border:
        slot: "0,1,2,3,4,5,6,7,8,9,17,18,26,27,28,29,30,31,32,33,34,35"
        material: GRAY_STAINED_GLASS_PANE
        name: " "

      background:
        slot: "10,12,14,16,19,21,23"
        material: LIGHT_GRAY_STAINED_GLASS_PANE
        name: " "

      top-kills:
        slot: 11
        material: DIAMOND_SWORD
        name: "<gradient:#ef4444:#dc2626><bold>⚔ Top Kills</bold></gradient>"
        lore:
          - ""
          - "<gray>Players ranked by"
          - "<gray>total kills."
          - ""
          - "<gradient:#FF6B35:#FFD700>View kills</gradient>"
        action: "[tab] kills"

      top-wins:
        slot: 13
        material: GOLDEN_APPLE
        name: "<gradient:#10b981:#34d399><bold>🏆 Top Wins</bold></gradient>"
        lore:
          - ""
          - "<gray>Players ranked by"
          - "<gray>total game wins."
          - ""
          - "<gradient:#FF6B35:#FFD700>View wins</gradient>"
        action: "[tab] wins"

      top-streak:
        slot: 15
        material: BLAZE_POWDER
        name: "<gradient:#f59e0b:#fbbf24><bold>🔥 Top Streaks</bold></gradient>"
        lore:
          - ""
          - "<gray>Players ranked by"
          - "<gray>best win streak."
          - ""
          - "<gradient:#FF6B35:#FFD700>View streaks</gradient>"
        action: "[tab] streak"

      back:
        slot: 22
        material: ARROW
        name: "<gradient:#FF6B35:#FFD700><bold>↩ Back</bold></gradient>"
        lore:
          - ""
          - "<gray>Return to main menu"
        action: "[open_menu] main_hub"

      close:
        slot: 20
        material: BARRIER
        name: "<gradient:#ef4444:#dc2626><bold>✖ Close</bold></gradient>"
        lore:
          - ""
          - "<gray>Close this menu"
        action: "[close]"


  # ------------------------------------------
  #      Leaderboard View (Per Category)
  # ------------------------------------------
  leaderboard-view:
    title: "<gradient:#FFD700:#FF6B35><bold>🏆 Top {tab}</bold></gradient>"
    size: 5

    entry-slots:
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 16
      - 19
      - 20
      - 21

    entry-item:
      material: PLAYER_HEAD
      name: "<gold>#{rank}</gold> <white>{player}</white>"
      lore:
        - ""
        - "<gray>Value: <gold>{value}</gold>"

    items:
      border:
        slot: "0,1,2,3,4,5,6,7,8,9,17,18,26,27,35,36,37,38,39,40,41,42,43,44"
        material: GRAY_STAINED_GLASS_PANE
        name: " "

      background:
        slot: "22,23,24,25,28,30,32,34"
        material: LIGHT_GRAY_STAINED_GLASS_PANE
        name: " "

      tab-kills:
        slot: 29
        material: DIAMOND_SWORD
        name: "<gradient:#ef4444:#dc2626><bold>⚔ Kills</bold></gradient>"
        lore:
          - ""
          - "<gradient:#FF6B35:#FFD700>Switch tab</gradient>"
        action: "[tab] kills"

      tab-wins:
        slot: 31
        material: GOLDEN_APPLE
        name: "<gradient:#10b981:#34d399><bold>🏆 Wins</bold></gradient>"
        lore:
          - ""
          - "<gradient:#FF6B35:#FFD700>Switch tab</gradient>"
        action: "[tab] wins"

      tab-streak:
        slot: 33
        material: BLAZE_POWDER
        name: "<gradient:#f59e0b:#fbbf24><bold>🔥 Streaks</bold></gradient>"
        lore:
          - ""
          - "<gradient:#FF6B35:#FFD700>Switch tab</gradient>"
        action: "[tab] streak"

      back:
        slot: 36
        material: ARROW
        name: "<gradient:#FF6B35:#FFD700><bold>↩ Back</bold></gradient>"
        lore:
          - ""
          - "<gray>Return to leaderboards"
        action: "[open_menu] leaderboards"

      close:
        slot: 44
        material: BARRIER
        name: "<gradient:#ef4444:#dc2626><bold>✖ Close</bold></gradient>"
        lore:
          - ""
          - "<gray>Close this menu"
        action: "[close]"

Still stuck? Ask about this page