Bungee Configuration

Bungee Configuration

This page is about the Bungee config.yml file and the various settings it provides.
For Bukkit see Bukkit Configuration

Settings are provided with the Settings Enum class that reads the config.

• Settings class

Most of the Bungee settings affect the state of Plan on Bukkit servers connected to it. If you want to set these settings individually for Bukkit servers set Bungee-Override.CopyBungeeSettings to false on the Bukkit server.

Page Version: 4.3.2

Settings

Server

Setting	Default	Affects	Description
IP	0.0.0.0	Bungee	Since Bungee does not provide a get IP method, IP of the server running Bungee has to be manually set. Set this to an address or IP that connects to the Bungee server machine. If this setting is not changed from default the plugin will not function
Network.Name	'Plan'	Bungee	This name is displayed on the Network page.

Bukkit Server Specific Settings (Servers)

These settings are automatically generated and the default values are copied from the Bukkit config on the first connection (After Plugin channel message)

Format:

  UUID:
    WebServerPort: 8034
    ServerName: Example
    ThemeBase: Default

Setting	Description
WebServerPort	Changes the WebServer.Port of a single Bukkit server
ServerName	Changes the Server.ServerName of a single Bukkit server
ThemeBase	Changes the Theme.Base of a Single Bukkit server, this allows for different themes for different servers.

Plugin

Setting	Default	Affects	Description
Debug	false	Bungee	Logger debug mode, takes options 'true'/'both','false','console','file'.
Locale	default	Bukkit	2 letter Locale code, selects the locale used (Found inside the jar)
WriteNewLocaleFileOnEnable	false	Bungee	Writes a new locale file to /plugins/Plan/ next time Plan enables.
Dev	false	Bungee	Additional Debug, Benchmark & Error logs only useful while developing.
Allow-Update-Command	true	Both	Allows execution of updates with upcoming update command
Notify-About-DEV-Releases	false	Both	If true notifications about DEV releases are given to players
KeepLogsForXDays	7	Both	Number of days after which log files are removed

WebServer

Setting	Default	Affects	Description
Port	8804	Bungee	Main WebServer port.
InternalIP	0.0.0.0	Bungee	Internal InetAddress to start the WebServer on.
Security.Certificate		Bungee	[[View the tutorial on setting up a SSL Certificate

Database

Setting	Default	Affects	Description
Host	localhost	Both	MySQL host address
Port	3306	Both	MySQL host port
User	root	Both	User for editing the database
Password	minecraft	Both	Password of User
Database	Plan	Both	Name of the Database to use
LaunchOptions	"?rewriteBatchedStatements=true&useSSL=false"	Both	Launch options to use

Commands

Setting	Default	Affects	Description
AlternativeIP.Enabled	false	Bungee	Enables the use AlternativeIP in the URL to the WebServer
AlternativeIP.Link	your.ip.here:%port%	Bungee	Address to use as link in inspect and analyze commands if setting above is enabled. %port% will be replaced with the Port automatically. If you have port-forwarded an alternate address to the webserver port, %port% is not required.
Colors	'&2', '&7', '&f'	Bukkit	Color codes to use for command messages

Analysis

Setting	Default	Affects	Description
AutoRefreshPeriod	60	Bukkit	Refreshes Analysis results periodically (minutes)
Active	30, 2	Bukkit	Affects calculation of Activity Index
Export.Enabled	false	Bungee	See External WebServer Use for more information

Data

Setting	Default	Affects	Description
AFKThresholdMinutes	3	Bukkit	Time the player has to be still before the stand-still time is added to the afk time when they move again.
Commands.LogUnknownCommands	false	Bukkit	Log commands that are not registered, e.g. /bremobmreb
Commands.CombineCommandAliases	true	Bukkit	Combines command aliases to the main command, e.g. /i to /give
Geolocations	false	Both	Enable Geolocation gathering
KeepInactivePlayersForDays	180	Both	After this number of days the data of a player is removed completely

Customization

Setting	Default	Affects	Description
Formatting.DecimalPoints	'#.##'	Bukkit	How many decimal points should be displayed
Formatting.TimeAmount		Bukkit	Time amounts are formatted by replacing the placeholders of these settings. If a %zero% is added to Hours, Minutes or Seconds, a zero will be added to single digit numbers, e.g. %zero%%seconds% -> 04. This allows time display of 04:43:23 for example.
Formatting.Dates		Bukkit	Dates are formatted using SimpleDateFormat patterns
Formatting.Dates.RecentDays		Bukkit	Replaces few recent date days with 'Today', 'Yesterday', 'Friday'
Display		Both	Affects how web elements are displayed.