Main configuration file

do-not-edit-this {
  # Do not edit this
  config-version="BUILD_COMMIT_HASH"
}

commands {
  glist {
    # Label to use for /glist command
    label="glist"
    # Permission required to execute /glist command
    permission="egl.commands.glist"
    # Optional, define aliases for /glist command
    aliases=["globalist"]
    # If enabled, a GUI will be displayed when a player executes this command
    # If disabled, data will be displayed in chat
    # To use this feature you must add Protocolize to your proxy:
    # https://www.spigotmc.org/resources/protocolize-protocollib-for-bungeecord-waterfall-velocity.63778/
    use-gui-menu=true
  }

  slist {
    # Label to use for /slist command
    label="slist"
    # Permission required to execute /slist command
    permission="egl.commands.slist"
    # Optional, define aliases for /slist command
    aliases=["serverlist"]
    # If enabled, a GUI will be displayed when a player executes this command
    # If disabled, data will be displayed in chat
    # To use this feature you must add Protocolize to your proxy:
    # https://www.spigotmc.org/resources/protocolize-protocollib-for-bungeecord-waterfall-velocity.63778/
    use-gui-menu=true
  }

  egl {
    # Label to use for /egl command
    label="egl"
    # Permission required to execute /egl command
    # Warning!!! This is a privileged command, only give this permission to administrators.
    permission="egl.commands.egl"
    # Optional, define aliases for /egl command
    aliases=["serverlist"]
  }
}

general {
  # Prefix for chat messages
  prefix="<bold><aqua>EGlist ></aqua></bold><reset>"
  # Supported languages: en (english), es (spanish)
  language="en"
  # Players per row (/slist)
  players-per-row=2
  # Players to display per page (/slist)
  players-per-page=16
  # Cache configuration
  cache {
    # Cache players that are connected in a certain server (/slist)
    server-players {
      # Set true to enable this cache
      enable=true
      # Number of seconds to keep the cache, after this period cache will be refreshed
      time=20
    }
  }
  # If empty servers should be hidden (when server has no players connected)
  hide-empty-servers=true
  # Number of servers to display on each page (/glist)
  servers-per-page=8
  # The number of players required to display a server (/glist), set 0 to always display empty servers.
  min-players-required-to-display-server=0
  # If server names should be displayed as uppercase (/glist and /slist)
  display-server-name-uppercase=false
}

behavior {
  # Related to vanish
  vanish {
    # If vanish should be handled by plugin
    enable=true
    # If vanished players should be hidden, useful if you want /glist to be used by players.
    hide-vanished-users=true
    # Permission to allow a player to see vanished players in /glist
    hide-bypass-permission="egl.bypass.vanish.hide"
  }

  # Related to AFK state
  afk {
    # If AFK state should be handled by plugin
    enable=true
  }
}

# Updater configuration
updates {
  # If plugin should check for new updates
  check-for-updates=true
  # Period to check for updates in seconds
  check-interval=300
  # Notifications
  notify {
    # Notify when a player joins to proxy
    on-join {
      # Enable this notification
      enable=true
      # Milliseconds to delay update message sent in chat (if an update is available)
      delay=2500
      # Only players with this permission can see the update message (if an update is available)
      permission="ebcl.update.notify"
    }

    # Console notification
    console {
      # Enable this notification
      enable=true
      # Notification interval in seconds
      notification-interval=1800
    }
  }
}

# Servers to ignore, all servers in this list will be hidden from /glist
# Also ignored servers will not be taken in account for server groups.
ignore-servers {
  # Ignore servers by exact name
  by-name=[
    "login1",
    "login2",
    "login3"
  ]
  # Ignore servers that match RegEx pattern
  # You can use this tool to test a RegEx expression: https://regexr.com/
  by-pattern=[
    "login.*"
  ]
}

# Group servers, useful if you have multiple instances of a same server
group-servers {
  # Example: lobby1, lobby2, lobby3 and lobby4 servers will be grouped as one server named "lobby"
  lobby=[
    "lobby1",
    "lobby2",
    "lobby3",
    "lobby4"
  ]
  # Example: all servers that start with "bedwars-lobby" and "bedwars-game" will be grouped as one server named "bedwars"
  bedwars {
    # RegEx pattern.
    # You can use this tool to test a RegEx expression: https://regexr.com/
    patterns=[
      "bedwars-game.*",
      "bedwars-lobby.*"
    ]
  }
}

This section is used by EnhancedGlist to know the current state of configuration and apply updates if needed, you should never edit this.

Define servers to be ignored from server list (i.e. list displayed when /glist command is executed)

Group multiple servers by name. You can define many groups as you want, there is no limit of groups.

Examples:

Group multiple lobbies using exact name, in this example, lobby1, lobby2, lobby3 and lobby4 will be grouped as "lobby".

group-servers {
  lobby=[
    "lobby1",
    "lobby2",
    "lobby3",
    "lobby4"
  ]
}

Also this can be done if you uses a Regex pattern to group all servers that starts with "lobby" word.

group-servers {
  lobby=[
    patterns=[
      "lobby.*"
    ]
  ]
}

In this example, lobby1, lobby2, lobby3 and lobby4 will be grouped as "lobby", and all servers that starts with "bedwars-game" and "bedwars-lobby" will be grouped as "bedwars".

group-servers {
  lobby=[
    "lobby1",
    "lobby2",
    "lobby3",
    "lobby4"
  ]
  bedwars {
    patterns=[
      "bedwars-game.*",
      "bedwars-lobby.*"
    ]
  }
}