Bukkit Configuration

Bukkit Configuration

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

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

• Settings class

Page version: 4.1.7

Settings

Server

Setting	Default	Description
ServerName	'Plan'	Name of the server, placed on the Analysis page and used to access the analysis page on Bungee WebServer

Plugin

Setting	Default	Description
Debug	false	Logger debug mode, takes options 'true'/'both','false','console','file'.
Locale	default	2 letter Locale code, selects the locale used (Found inside the jar)
WriteNewLocaleFileOnEnable	false	Writes a new locale.txt file to plugin folder on plugin enable and sets this back to false.
Bungee-Override.StandaloneMode	false	Overrides Bungee usage when connected to a Bungee network, same as running Plan on a single Bukkit server, but with Plan installed on Bungee.
Bungee-Override.CopyBungeeConfig	true	Copies the changes made to bungee config to this one. Set to true if you want to set each server's settings individually
Dev	false	Enables more debug, benchmark & error logs only useful while developing

WebServer

Setting	Default	Description
Port	8804	Port of the Webserver
InternalIP	0.0.0.0	Internal InetAddress to start the WebServer on. 0.0.0.0 manages the Internal IP automatically.
Security.SSL-Certificate		[[View the tutorial on setting up a SSL Certificate
DisableWebServer	false	Disables the WebServer. This is for External WebServer Use
ExternalWebServerAddress	https://www.example.address	Address to give to users when WebServer is offline.

Database

Setting	Default	Description
Type	SQLite	'MySQL' or 'SQLite'
MySQL.Host	localhost
MySQL.Port	3306
MySQL.User	root	User for editing the database
MySQL.Password	minecraft	Password of MySQL.User
MySQL.Database	Plan	Name of the Database to use
MySQL.LaunchOptions	?rewriteBatchedStatements=true&useSSL=false	Launch options to use

Commands

Setting	Default	Description
AlternativeIP.Enabled	false	Enables the use AlternativeIP in the URL to the WebServer
AlternativeIP.Link	your.ip.here:%port%	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	Color codes to use for command messages

Analysis

Setting	Default	Description
AutoRefreshPeriod	60	Refreshes Analysis results periodically (minutes)
Active		These settings affect the ActivityIndex
LogProgress	true	Logs progress of Analysis to console, recommended to be set to false with high refresh period.
Export.Enabled	false	See External WebServer Use for more information

Data

Setting	Default	Description
Commands.LogUnknownCommands	false	Log commands that are not registered, e.g. /bremobmreb
Commands.CombineCommandAliases	true	Combines command aliases to the main command, e.g. /i to /give

Customization

Setting	Default	Description
UseServerTime	true	Force HighCharts to use Server TimeZone
Display.SessionsAsTable	false	Replaces Session Harmonica with a Table
Display.LargestWorldPercInSessionTitle	false	Adds most used world, eg world (94.65%) to the Session Accordion headers (Similar to session table)
OrderWorldPieByPercentage	false	By Default WorldPie is ordered alphabetically, colors are still determined alphabetically.
MaxSessions	50	How many sessions are visible on a page
MaxPlayers	2500	How many players are visible on Server Analysis Playerlist, larger number takes longer to load.
MaxPlayersPlayersPage	25000	How many players are visible on /players page Playerlist
PlayersTableFooter	true	Should footer be displayed on the /players table?
PlayerIPs	true	Should IPs be displayed on /player pages at all?
Formatting.DecimalPoints	'#.##'	How many decimal points should be displayed
Formatting.Dates		Dates are formatted with SimpleDateFormat patterns
Formatting.Dates.RecentDays	true	The day in dates is replaced by 'Today', 'Yesterday', 'Friday' for the few most recent days.
Formatting.TimeAmount		Time amounts are formatted by replacing the placeholders of these settings. More below.
WorldAliases		List of Worlds and the aliases used in graph generation. You can lump worlds together by setting their alias as the same value.

Formatting.TimeAmount Examples

Default:

Time	Formatted
400 days, 12 hours, 30 minutes and 20 seconds	1 year, 1 month, 5d 12h 30m 20s
400 days	1 year, 1 month, 5d
12 hours 20 sec.	12h 20s
0 sec.	0s

Extra Zeros

TimeAmount:
      Year: '1 year, '
      Years: '%years% years, '
      Month: '1 month, '
      Months: '%months% months, '
      Day: '1d '
      Days: '%days%d '
      Hours: '%zero%%hours%:'
      Minutes: '%hours%%zero%%minutes%:'
      Seconds: '%minutes%%zero%%seconds%'
      Zero: '00:00:00'

Time	Formatted
400 days, 12 hours, 30 minutes and 20 seconds	1 year, 1 month, 5d 12:30:20
400 days	1 year, 1 month, 5d
12 hours 20 sec.	12:00:20
30 minutes	00:30:00
20 sec.	00:00:20
0 sec.	00:00:00

Theme

See Themes for more details about these settings

Plugins

If you have third party plugins installed, their analysis settings will be displayed here.
For example if Vault is taking too long it can be disabled. /plan status timings and the /debug-page can help figuring out what is taking all the time.