Plan/documentation/HtmlCustomization.md

Html Customization

The html web pages of the plugin can be completely customized. The plugin uses two .html files: analysis.html and player.html If the /plugins/Plan/ folder contains either of the files, they will be used instead of the ones found inside the .jar. This means you can copy the html files from the jar to the folder and edit them.

Page version: 3.4.0

Placeholders

The plugin uses placeholders to place the values into the html. Here I will go through each placeholder.

• PlaceholderUtils.java

Inspect placeholders

Placeholder	Description	Example
%currenttime%	Server epoch ms, used for clock.	1496486156
%refreshlong%	Epoch ms of last refresh (server time)	1496486156
%uuid%	Players UUID or 'Hidden' if config setting for UUID visibility is disabled.	88493cd1-567a-49aa-acaa-84197b5de595
%lastseen%	A formatted version of the last Epoch second the user was seen.	Feb 02 18:03:12
%logintimes%	How many times the user has logged in	34
%geoloc%	Demographics geolocation of the user.	United States
%active%	'Player is Active' or 'Player is Inactive' depending on isActive- method.
%age%	'Not Known' if age is not known (-1) or the users age.	14
%gender%	'Unknown', 'Male' or 'Female'
%gm0%	A formatted version of milliseconds spent in SURVIVAL.	1h 30m 4s
%gm1%	A formatted version of milliseconds spent in CREATIVE.	1h 30m 4s
%gm2%	A formatted version of milliseconds spent in ADVENTURE.	1h 30m 4s
%gm3%	A formatted version of milliseconds spent in SPECTATOR.	1h 30m 4s
%gmdata%	Number array of seconds spent in each gamemode, used by piechart.	[32423, 5436, 432543, 23]
%gmlables%	Array of labels used by piechart.	["Survival", "Creative", "Adventure", "Spectator"]
%gmcolors%	List of html color codes that depend on config values.	"#ffffff","#eeeeee","#000000","#213123"
%gmtotal%	A formatted version of milliseconds spent in All gamemodes.	1h 30m 4s
%ips&	An array of users ip addresses or 'Hidden'.	[127.0.0.1/]
%nicknames%	Formatted Array of Users nicknames, with <span class="color_#"></span> wrapped to represent §#-color tags.	[Steve, <span class="color_4">Steve</span>]
%name%	User's username	Steve
%registered%	A formatted version of the Epoch second the user registered.	Feb 02 18:03:12
%timeskicked%	Number how many times the user was kicked.	5
%playtime%	A formatted version of milliseconds spent on the server.	1h 30m 4s
%banned%	<span class="color_4">Banned</span> or nothing.
%op%	', Operator (Op)' or nothing
%isonline&	`	Onlineor
%deaths%	Number of deaths.	24
%playerkills%	Number of Player kills the user has (Size of KillData list)	14
%sessionstable%	Old feature, no longer in use.
%sessionaverage%	A formatted version of the average length of all of the sessions.	10m 23s
%killstable%	Table containing up to 10 of the most recent player kills. Example contains one line.	<table class="sortable table"><thead><tr><th>Date</th><th>Killed</th><th>With</th></tr></thead><tbody><tr><td sorttable_customkey="324123421">FORMATTED_TIME</td><td>Rsl1122</td><td>DIAMOND_SWORD</td></tr></tbody></table>
%version%	Version of the plugin	3.2.5
%planlite%	Replaced with an empty string. Old feature.
%dataweek%	Array containing users online numbers for last 7 days, used by the graph.	[0, 0, 1, 1, 1, 0, 0, 1, 0, 0]
%labelsweek%	Array containing formatted time labels corresponding the data array.	["Feb 02 18:03:12", "Feb 02 18:06:32"]
%playersgraphcolor%	Color code for the online graph in the config.	ffffff
%playersgraphfill%	Color code for fill of the online graph in the config.	000000
%gm0col%	Color of the SURVIVAL box in the config	ffffff
%gm1col%	Color of the CREATIVE box in the config	000000
%gm2col%	Color of the ADVENTURE box in the config	ffffff
%gm3col%	Color of the SPECTATOR box in the config	000000
%datapunchcard%	Data for the punch card graph	[{x:0, y:2},{x:1, y:2}]
%datasessiondistribution%	Data for the session length distribution graph	[54, 34, 12]
%labelssessiondistribution&	Labels for the session length distribution bars	["0-5 min", "5-10 min", "10-15 min"]
%inaccuratedatawarning%	Replaced with a warning if the player has registered 3 minutes ago	<div class="warn">Data might be inaccurate, player has just registered.</div>
%plugins%	Content for the Plugins tab	<div class="columns"><div class="about box column">CONTENT</div><div class="about box column">CONTENT</div></div>

Analysis placeholders

Placeholder	Description	Example
%currenttime%	Server epoch ms, used for clock.	1496486156
%refreshlong%	Epoch ms of last refresh (server time)	1496486156
%gm0%	Total percentage all players have spent in SURVIVAL	66%
%gm1%	Total percentage all players have spent in CREATIVE	19%
%gm2%	Total percentage all players have spent in ADVENTURE	10%
%gm3%	Total percentage all players have spent in SPECTATOR	5%
%active%	Number of Active players	4
%inactive%	Number of Inactive players.	43
%banned%	Number of Banned players.	5
%joinleaver%	Number of players who have only joined once	100
%activitytotal%	Total number of players in the database.	152
%npday%	Number of new players who have joined in the last 24h	5
%npweek%	Number of new players who have joined in the last 7d	13
%npmonth%	Number of new players who have joined in the last 30d	53
%commanduse%	Table format lines for commands & times used, sorted to descending order.	<tr><td><b>/spawn</b></td><td>42</td></tr><tr><td><b>/plan</b></td><td>4</td></tr>
%totalcommands%	Number of unique commands used	2
%avgage%	'Not Known' or an average of known user ages.	14.5
%avgplaytime%	Formatted average playtime of all players.	1h 30m 4s
%totalplaytime%	Formatted total playtime of all players.	4d 2h 43m 5s
%op%	Amount of Operators on the server	1
%refresh%	Formatted time since Epoch second of the last refresh.	4m 5s
%totallogins%	Total number of logins of all players	342
%top20mostactive%	Not in use, old feature.	Error: Replace rule was not set
%recentlogins%	Buttons with links to the inspect pages of most recent players	<p><a class="button" href="http://localhost:8804/bAkEd/player/Rsl1122">Rsl1122</a> </p>
%deaths%	Total amount of deaths for all players	43
%playerkills%	Total amount of player kills	32
%mobkills%	Total amount of mobs killed	432
%sessionaverage%	Formatted time amount of the average session length	4m 30s
%version%	Version of Plan	3.2.0
%planlite%	Replaced with an empty string. Old feature.
%uniquejoinsday%	Replaced with number of unique players	5
%uniquejoinsweek%	Replaced with number of unique players	47
%uniquejoinsmonth%	Replaced with number of unique players	234
%avguniquejoins%	Replaced with number of average joins / day	56
%avguniquejoinsday%	Replaced with number of average joins / day in last 24h	56
%avguniquejoinsweek%	Replaced with number of average joins / day in last 7d	60
%avguniquejoinsmonth%	Replaced with number of average joins / day in last 30d	59
%sortabletable%	Multi column table containing all players	Created with this code
%dataday%	Data for 24h online activity	[0, 0, 0, 0, 1]
%dataweek%	Data for 7d online activity	[0, 0, 0, 0, 1]
%datamonth%	Data for 30d online activity	[0, 0, 0, 0, 1]
%labelsday%	Labels for each point on 24h graph	[FORMATTED TIMESTAMPS]
%labelsweek%	Labels for each point on 7d graph	[FORMATTED TIMESTAMPS]
%labelsmonth%	Labels for each point on 30d graph	[FORMATTED TIMESTAMPS]
%activitydata%	Data for the sectors on the activity pie	[32, 43, 3, 2]
%labelsactivity%	Labels for the sectors of activity pie	["Active", "Inactive", "Unknown", "Banned"]
%geomapcountries%	Country Array for Chloropleth map	[...]
%geomapcodes%	Country code Array for Chloropleth map	[...]
%geomapz%	Number array for Chloropleth map	[...]
%gmdata%	Data for the sectors on the gm usage pie	[43242, 432423421, 35345, 5432534]
%gmlabels%	Labels for the sectors of gm pie.	["Survival", "Creative", "Adventure", "Spectator"]
%activecol%	Color of the ACTIVE sector in config	ffffff
%inactivecol%	Color of the INACTIVE sector in config	000000
%joinleavecol%	Color of the UNKNOWN sector in config	ffffff
%bancol%	Color of the BANNED sector in config	000000
%playersgraphcolor%	Color code for the online graph in the config.	ffffff
%playersgraphfill%	Color code for fill of the online graph in the config.	000000
%gm0col%	Color of the SURVIVAL box in the config	ffffff
%gm1col%	Color of the CREATIVE box in the config	000000
%gm2col%	Color of the ADVENTURE box in the config	ffffff
%gm3col%	Color of the SPECTATOR box in the config	000000
348e0f	Light color of green to be replaced with config value Main	ffffff
267F00	Darker color of green to be replaced with config value MainDark	000000
5cb239	Lighter color of green to be replaced with config value Secondary	ffffff
89c471	Lightest color of green to be replaced with config value Tertiary	000000
5da341	Darker color of green to be replaced with config value TertiaryDark	ffffff
%plugins%	Content for the Plugins tab	<div class="columns"><div class="about box column">CONTENT</div><div class="about box column">CONTENT</div></div>