BungeeCord Configuration Guide

Aug 17, 2017 at 4:33 AM
BungeeCord Configuration Guide
  • BungeeCord Configuration

    Information for BungeeCord's config.yml



    Default config.yml
    Code (Text):

    player_limit: -1
    ip_forward: false
    permissions:
      default:
      - bungeecord.command.server
      - bungeecord.command.list
      admin:
      - bungeecord.command.alert
      - bungeecord.command.end
      - bungeecord.command.ip
      - bungeecord.command.reload
    timeout: 30000
    log_commands: false
    online_mode: true
    servers:
      lobby:
        motd: '&1Just another BungeeCord - Forced Host'
        address: localhost:25565
        restricted: false
    listeners:
    - query_port: 25577
      motd: '&1Another Bungee server'
      priorities:
      - lobby
      bind_local_address: true
      tab_list: GLOBAL_PING
      query_enabled: false
      host: 0.0.0.0:25577
      forced_hosts:
        pvp.md-5.net: pvp
      max_players: 1
      tab_size: 60
      ping_passthrough: false
      force_default_server: false
    disabled_commands:
    - disabledcommandhere
    network_compression_threshold: 256
    groups:
      md_5:
      - admin
    connection_throttle: 4000
    stats: f2876aa6-74d2-468c-90ee-1377111f1c9f

     
    groups
    Default:
    Code (Text):
    md_5:
    - admin
    Type:
    Description:
    Here, you can assign players to a permission group that you created earlier in the configuration.
    The format is groups, followed by each player, followed by each group he/she is in. By default "md_5" is given "admin" group, which gives permissions as defined by permissions section. Every player has default. Only add players who need more than the default permissions.

    disabled_commands
    Default: disabledcommandhere
    Type: List
    Description: Use this to disable commands on your BungeeCord instance.

    player_limit
    Default: -1
    Type: Integer
    Description: Global player limit for your BungeeCord instance. If set to -1, this will allow an unlimited amount of users to join.

    stats
    Default: (randomly generated string)
    Type: String
    Description: Used for stats purposes, please do not remove or alter the code. This is a randomly generated number in the purpose of providing stats. Stats are anonymous packets of usage collected on MCStats. This is something you should never edit, so please leave it be!

    permissions
    Code (Text):
    default:
    - bungeecord.command.server
    - bungeecord.command.list
    admin:
    - bungeecord.command.alert
    - bungeecord.command.end
    - bungeecord.command.ip
    - bungeecord.command.reload
    Description: These are the permissions of what commands or actions you can use within the proxy. Please note, that these are different to Bukkit/Spigot permissions. The permissions are group based and are used to attach players later on in the configuration. All players will have ability to use the commands under "default", those players given the "admin" group in the "groups" section are allowed to use the extra commands for BungeeCord as stated below that group. Note each group only inherits "default" so you may need to put the same node in different groups if you add more.

    listeners
    Description: The following items are configurable options that can be found under the listeners section of the BungeeCord configuration. Multiple listeners can be added to listen on several IP's and ports.
    Code (Text):
    listeners:
    - max_players: 1000
      host: 0.0.0.0:25565
      bind_local_address: true
      ping_passthrough: true
      tab_list: GLOBAL
      priorities:
      - lobby
      forced_hosts:
        pvp.md-5.net: pvp
      tab_size: 60
      force_default_server: false
      motd: 'empty'
      query_enabled: false
      query_port: 25577
    #Start listener 2
    - max_players: 1000
      host: 0.0.0.0:25566
      bind_local_address: true
      ping_passthrough: true
      tab_list: GLOBAL
      priorities:
      - lobby
      forced_hosts:
        factions.md-5.net: factions
      tab_size: 60
      force_default_server: false
      motd: 'empty'
      query_enabled: false
      query_port: 25578

    max_players
    Default: 1
    Type: Integer
    Description: The max player limit shown in the minecraft client's multiplayer menu. Note that this limit is fake, you can set it to 0, players will still be able to join. Look at player_limit above for a "real" player limit.

    host
    Default: 0.0.0.0:25577
    Type: String
    Description: The IP and Port in which the BungeeCord instance will be hosted on. Use 0.0.0.0 to listen to all IPs (recommended).

    bind_local_address
    Default: true
    Type: Boolean
    Description: Whether the address Bungee uses to connect to your servers will be explicitly set to the address Bungee is listening on. This serves no purpose unless your system has multiple IP addresses.

    ping_passthrough
    Default: false
    Type: Boolean
    Description: Whether to pass the ping through when we can reliably get the target server (force default server).

    tab_list
    Default: GLOBAL_PING
    Type: String
    Description: The tab list has a choice of 3 options.
    GLOBAL_PING: This shows all players connected to the proxy, complete with ping.
    GLOBAL: As above, but without updating their ping.
    SERVER: This shows the local players on the server you are connected to.

    Note - BungeeCord 1.8+ versions currently do not have working GLOBAL or GLOBAL_PING options due to 1.8+ having a new tab list. You may use the plugin GlobalTablist or BungeeTabListPlus to have this feature in 1.8+

    priorities
    Default: lobby
    Type: List
    Description: On connection of first time players, or if forcing default server, all connecting players, BungeeCord goes through this list of servers from top to bottom and tries to forward the connection to each of them. So if you would like to support multiple client versions, simply specify at least one server per version and BungeeCord will do the matching for you.

    forced_hosts
    Default: pvp.md-5.net: pvp
    Type: Map
    Description: Allows for redirection. If the pvp.md-5.net sub-domain of the domain md-5.net is joined, it will bypass the default server and go to the server that is stated in the config, in this case directly to the pvp server. Note: this requires you to make sub-domains forwarded to your BungeeCord address via the main Dynamic DNS as for your main domain.

    tab_size
    Default: 60
    Type: Integer
    Description: The amount of players that will show up in the tab list (Pressing tab on keyboard)

    force_default_server
    Default: false
    Type: Boolean
    Description: If true, the player will always connect to the default server when the join the server. If false, the player will join the server they were last connected to. Note: "forced_hosts" does NOT override this. To make the "forced_hosts" setting work, set this to false.

    motd
    Default: "Another Bungee Server"
    Type: String
    Description: The message to be displayed in the multiplayer menu when players ping the server.

    query_enabled
    Default: false
    Type: Boolean
    Description: Whether to enable UDP query.

    query_port
    Default: 25577
    Type: Integer
    Description: What port to run the UDP query on

    timeout
    Default: 30000
    Type: Integer
    Description: How long the BungeeCord proxy should go unresponsive before shutting off all connections.

    connection_throttle
    Default: 4000
    Type: Integer
    Description: The time delay before a client is allowed to connect again after a recent connection attempt to prevent attacks (in milliseconds).

    servers
    Code (Text):
    lobby:
      address: localhost:25565
      restricted: false
      motd: '&1Just another BungeeCord - Forced Host'
    Note: restricted prevents players from joining the server unless they have the bungeecord.server.[servername] permission
    Type:
    Map
    Description: Within this section, you will list all the servers that will be connected to via the BungeeCord instance. It is recommended to use lowercase for the names of the servers.

    network_compression_threshold
    Default: 256

    ip_forward
    Default: true
    Type: Boolean
    Description: Whether to enable IP (which forwards the players true IP to Bukkit, rather than the proxy IP) and UUID forwarding (which forwards the players true online-mode UUID to Bukkit, rather than an offline-mode username hash!)
    If you're running an online-mode: true server, It is highly recommended you use this option!

    If using this option, please follow this guide to ensure that you have enabled it correctly.

    online_mode
    Default: true
    Type: Boolean
    Description: Whether the BungeeCord instance will authenticate with the Mojang servers. If set to false, cracked players will also be able to join your server.
  • Loading...
  • Loading...