PlayerBalancer Configuration Reference

# The version this was generated on.
version: ${project.version}

# Settings for the plugin, modify this to your liking
settings:
  # If it is false the plugin will not work except the plugin main command.
  enabled: false

  # Mode for the plugin to work.
  # LOWEST: The server chosen is the first one found with the lowest player count.
  # HIGHEST: The server chosen is the first one found with the highest player count.
  # RANDOM: The server chosen is completely random. Using http://goo.gl/eo9oJL (java.security.SecureRandom)
  # MIXED: The server chosen is randomly, but only the servers with the lowest player count (In case more than one found). Generally slower. Using http://goo.gl/vA6EFp (java.util.Random)
  # PROGRESSIVE: The server chosen is the first one that is not full (in order).

  # This is the global mode, you can specify a mode for a group
  mode: RANDOM

  # Checking if the player is able to connect to a server by pinging it
  server_check:
    # Retry intents trying to find a valid server
    intents: 5

    # The amount of milliseconds between every server check
    interval: 10000

    # Determine if we should use the utility of BungeeCord for pinging servers or our custom one
    generic: true

    # If it is true, it will print information about the servers that have been checked
    info: false

    # Servers are marked as inaccessible when they are offline, but you can set them as non accessible when they have a specific
    # The description has to contain one string, you can use regex
    inaccessible_motds:
      - 'Game already started'

  # Connect the player to a frontend server when the player gets kicked of a server
  reconnect_kick:
    # If it is false it will kick the player out of the network
    enabled: true

    # When the plugin should reconnect the players, the message of kick should contain the reasons. You are able to use regex here
    reasons: ["Kicked from server", "Server is Restarting"]

    # Sent when the player gets moved to other server because of a kick
    # Placeholders: {kickedfrom} (The server the player was kicked from), {target} (The server the player is going to be connected), {reason} (The reason of the kick)
    message:
      enabled: true
      text: '&cYou have been kicked from {kickedfrom}'

    # Groups where players should be kicked to another frontend server when they are kicked on a frontend server
    recursive_groups:
      - 'main'

  # Delay when executing commands.
  delay:
    # If it is true, the connection will be delayed for X seconds, if not the player will connect immediately.
    enabled: false

    # The amount of time before connecting the player.
    seconds: 5

    # Placeholders: {server} (The target name), {time} (The amount of time before connecting).
    message: '&cYou will be connected to {server} in {time} seconds'

  # Servers where the commands of this plugin are disabled on.
  server_deny:
    # If it is true, the players inside any of the servers specified will not be able to execute commands.
    enabled: false

    # The servers where the commands will not work.
    servers:
      - 'DeniedServer'

    # The message when the player executes a command inside any of the denied servers.
    message: '&cThis command is disabled here.'

  # This commands takes care of connecting the player to a server inside the backend of the group of the player.
  join_command:
    # If it is false, the command will not exist.
    enabled: false

    # The name for the command, without slash.
    command: join

    # The permission for the command, leave blank for none.
    permission: ''

    # Aliases for the command.
    aliases: ["match"]

  # This commands takes care of connecting the player to a server inside the backend of the group of the player.
  # In case an extra argument is provided, it will connect the player to a server inside the backend of the group that the player provided.
  lobby_command:
    # If it is false, the command will not exist.
    enabled: true

    # The name for the command, without slash.
    command: lobby

    # The permission for the command, leave blank for none.
    permission: ''

    # Aliases for the command.
    aliases: ["hub", "leave", "back"]

  # This feature allows you to use a group-specific server that the plugin adds to connect a player to the frontend of that group
  # The server name is '@' and the name of the group
  # When somone connects to that server made by the plugin the server the player will end up is one in the frontend.
  group_server: true

  # This plugin supports redisbungee for multiple proxy instances. Get a look on redisbungee at
  # https://www.spigotmc.org/resources/13494/
  # More info at https://minecraft.minimum.io/wiki/RedisBungee/FAQ
  redisbungee: false

  # Enable this if you want the plugin to reload when bungeecord is reloaded
  autoreload: true

  # Enable this if you want players to have assigned a server so they join the same frontend server
  # It gets reset when they disconnect of the proxy
  assign_target: false

  # Messages, you can use color codes and specific placeholders for each message. Colors at http://minecraft.gamepedia.com/Formatting_codes
  messages:
    # Sent when the player is not inside a group.
    command_unavailable: '&cThis command cannot be used in this server'

    # Sent when no server has been found for connecting.
    connect_failure: '&cNo server has been found! Try it later!'

    # Sent when no group has been found with a name.
    # Placeholders: {group} (The group name).
    undefined_group: '&cThere is no set of servers named {group}'

    # Sent when the player is connecting to a server.
    # Placeholders: {server} (The target name).
    connecting_message:
      enabled: true
      text: '&aConnecting to {server}...'

    # Sent when the player has connected to a server.
    # Placeholders: {server} (The target name).
    connected_message:
      enabled: false
      text: '&aYou have entered {server}'
groups:
  # Wildcards:
  # @: Adds all the frontend servers to the backend of a group. Usage: @group
  # *: Adds all the servers that start with it. Usage: Hub*
  # Notes:
  # It is not recommended to remove the main group
  # You can set a specific mode for a group
  main:
    enabled: true
    servers:
      # This is the list of the servers that are "public" for the player, mainly the hubs.
      frontend:
        - 'Hub*'

      # This is the list of the server that are "protected" for the player, like the minigames servers or more hubs.
      backend:
        - '@skywars'
        - '@survivalgames'
  skywars:
    enabled: true
    servers:
      frontend:
        - 'SkywarsHub1'
        - 'SkywarsHub2'
        - 'SkywarsHub3'
      backend:
        - 'Skywars1'
        - 'Skywars2'
        - 'Skywars3'
  survivalgames:
    enabled: true
    servers:
      frontend:
        - 'SurvivalGamesHub1'
        - 'SurvivalGamesHub2'
        - 'SurvivalGamesHub3'
      backend:
        - 'SurvivalGames1'
        - 'SurvivalGames2'
        - 'SurvivalGames3'