Html Customization
Since 4.1.7 a File diff tool branch has been created & can be used for diffs on GitHub.
View the HTML branch
The html web pages of the plugin can be completely customized. The way you do this is by copying and editing the files from Plan.jar into /plugins/Plan/web/-folder.
This means that you can add a links to important pages related to your server, change layout to some extent and more customization than bare config settings allow.
Everything inside the web folder inside the jar:
Please note that Themes function by replacing default color variables in the .css and .html files and changing them may break the functionality.
Some files contain placeholders that are replaced at runtime. They look like this: ${placeholder}. JavaScript or CSS files do not contain placeholders.
Some Placeholders may contain page layout components that are calculated during analysis, usually because they contain more than a single element.
Placeholder list version: 4.0.5
Simple page used for Error pages and Analysis Notification.
| ${placeholder} | Description | Example |
|---|---|---|
| title | Title of the header on the Error page | 500 Internal Error |
| version | Version of Plan | 4.0.5 |
| paragraph | More in depth error information, formatted to go inside <p> tags |
- |
Page used for the /network page on BungeeCord systems.
| ${placeholder} | Description | Example |
|---|---|---|
| version | Version of PlanBungee | 4.0.5 |
| networkName | Name of the Network defined in the Config | SuperCool Network |
| playersOnline | Number of players online at the moment of updating the page | 43 |
| playersTotal | Total number of players found in the database | 4324 |
| playersNewDay | New players that have registered today | 76 |
| playersNewWeek | New players that have registered this week | 432 |
| contentServers | Structure placeholder: Server blocks | - |
| playersOnlineSeries | Data for the Players Online Graph (HighCharts) | [324, 434, 543, ..., 345] |
| playersGraphColor | Color code for the graph color defined in the config | #1E90FF |
Page used for /player/PlayerName pages
| ${placeholder} | Description | Example |
|---|---|---|
| refresh (unused) | Date & time page was rendered | May 30, 15:02 |
| playerName | Name of the Player | Rsl1122 |
| worldPieColors | List of World Pie colors defined in the config | "#0099C6", "#66AA00", ..., "#329262" |
| gmPieColors | List of GM Drilldown colors defined in the config | "#438c99", "#639A67", "#D8EBB5", "#D9BF77" |
| version | Version of Plan | 4.0.5 |
| networkName | Name of the Bungee network or Bukkit server depending on setup | SurvivalServer |
| playerClassification | Information about groups player belongs in separated with dots | Active/Inactive * (Banned) * (Operator) |
| nicknames | List of nicknames player has used | * Name<br>* Name2 |
| geolocations | List of countries player has logged in from | * Finland<br>* United States |
| registered | Date user registered | May 30 2017, 15:02 |
| lastSeen | Date user was last seen | Sep 26 2017, 13:43 |
| sessionCount | Number of sessions player has | 64 |
| playtimeTotal | Total playtime of the player | 52m 4s (Format depends on config) |
| sessionLengthMedian | Length of session at sessions / 2 | 14s (Format depends on config) |
| sessionLenghtLongest | Length of the longest session | 32m 54s (Format depends on config) |
| kickCount | Times player has been kicked | 0 |
| playerKillCount | PvP kill count | 32 |
| mobKillCount | Mob kill count | 324 |
| deathCount | Number of deaths | 5 |
| tableBodyActions | Table rows containing 3 values | Time, Action, Info |
| contentSessions | Structure placeholder: Contains session structure, either table or harmonica depending on config | - |
| sessionCountDay | How many sessions player has had in last 24h | 3 |
| playtimeDay | How long player has played in last 24h | 32m 54s (Format depends on config) |
| sessionLengthLongestDay | Longest session in the last 24h | 32m 20s (Format depends on config) |
| sessionCountWeek | How many sessions player has had in last 7d | 3 |
| playtimeWeek | How long player has played in last 7d | 32m 54s (Format depends on config) |
| sessionLengthLongestWeek | Longest session in the last 7d | 32m 20s (Format depends on config) |
| contentServerOverview | Structure placeholder: Contains data from each server on network | - |
| tabContentPlugins | Structure placeholder: Contains all dropdowns with boxes for plugins | - |
| timeZone | Offset to HighCharts timestamps | -2 (For GMT+2) |
| serverPieColors | Colors for server Pie in the config | "#0099C6", "#66AA00", ..., "#329262" |
| serverPieSeries | Data for HighCharts pie | - |
| worldPieSeries | Data for Overview tab server pie | - |
| gmSeries | Drilldown data for Overview tab server pie | - |
| punchCardSeries | Data for Puchcard graph on first tab | - |
| sessionTabGraphViewFunctions | JavaScript method calls to draw Session tab WorldPies | - |
Html used for /players page
| ${placeholder} | Description | Example |
|---|---|---|
| version | Version of Plan/PlanBungee | 4.0.5 |
| content | Table that contains all playernames, 8 per row | - |
Html used for /server/ on Bukkit and /server/ServerName on Bungee
| ${placeholder} | Description | Example |
|---|---|---|
| refresh (unused) | Date & time page was rendered | May 30, 15:02 |
| worldPieColors | List of World Pie colors defined in the config | "#0099C6", "#66AA00", ..., "#329262" |
| gmPieColors | List of GM Drilldown colors defined in the config | "#438c99", "#639A67", "#D8EBB5", "#D9BF77" |
| version | Version of Plan | 4.0.5 |
| serverName | Name of the Server this page is about (config setting) | SurvivalServer |
| playersOnline | Players online at the moment of page render | 43 |
| playersMax | Maximum number of players reported by Server | 100 |
| playersNewDay | Number of new players in last 24h | 12 |
| playersActive | Number of players who are considired "Active" | 543 |
| playersTotal | Total number of players who have played on this server in the database | 3240 |
| lastPeakTime | Date & time latest peak occurred (Last 30h) | May 30, 15:02 |
| playersLastPeak | How many players were online on last peak | 34 |
| bestPeakTime | Date & time best peak occurred | Sep 12 2017, 15:30 |
| playersBestPeak | How many players were online on best peak | 54 |
| sessionAverage | Average of all session lengths | 10m 20s (Format depends on config) |
| playersAverage | Average total number of players per day (All time) | 54 |
| playersNewAverage | Average total number of new players per day (All time) | 34 |
| playtimeTotal | Total playtime | 10m 20s (Format depends on config) |
| sessionCount | Total number of sessions on this server | 433 |
| killCount | Total number of Player kills on this server | 4342 |
| mobKillCount | Total number of Mob kills on this server | 543534 |
| deaths | Total number of Deaths on this server | 5435 |
| tableBodyRecentLogins | Table rows for recent logins table | Player, Session Started |
| playersDay | How many unique players joined in last 24h | 43 |
| playersWeek | How many unique players joined in last 7d | 543 |
| playersMonth | How many unique players joined in last 30d | 2340 |
| playersAverageDay | How many unique players joined per 24h in last 24h | 43 |
| playersAverageWeek | How many unique players joined per 24h in last 7d | 65 |
| playersAverageMonth | How many unique players joined per 24h in last 30d | 67 |
| playersNewDay | How many new players have joined in last 24h | 32 |
| playersNewWeek | How many new players have joined in last 7d | 340 |
| playersNewMonth | How many new players have joined in last 30d | 1204 |
| playesNewAverageDay | How many new players joined per 24h in last 24h | 32 |
| playesNewAverageWeek | How many new players joined per 24h in last 7d | 43 |
| playesNewAverageMonth | How many new players joined per 24h in last 30d | 42 |
| contentSessions | Structure placeholder: Contains session structure, either table or harmonica depending on config | - |
| tpsAverageDay | Average TPS for last 24h | 19.99 |
| cpuAverageDay | Average CPU usage for last 24h | 25.43% |
| ramAverageDay | Average RAM usage for last 24h | 5400.43 MB |
| entityAverageDay | Average number of entities for last 24h | 543.54 |
| chunkAverageDay | Average number of chunks for last 24h | 4393.43 |
| tpsAverageWeek | Average TPS for last 7d | 19.99 |
| cpuAverageWeek | Average CPU usage for last 7d | 25.43% |
| ramAverageWeek | Average RAM usage for last 7d | 5400.43 MB |
| entityAverageWeek | Average number of entities for last 7d | 543.54 |
| chunkAverageWeek | Average number of chunks for last 7d | 4393.43 |
| tableBodyPlayerList | Table rows for Players table | Player, Active, Playtime, Sessions, Registered, Last seen, Geolocation |
| commandUniqueCount | How many different commands have been used | 434 |
| commandCount | How many commands have been used in total | 43535 |
| tableBodyCommands | Table rows for Command Usage table | Command, Times used |
| tabContentPlugins | Structure placeholder: Contains all boxes for plugins | - |
| timeZone | Offset to HighCharts timestamps | -2 (For GMT+2) |
| playersOnlineSeries | Data for Players Online graph | - |
| playersGraphColor | Color code for the graph color defined in the config | #1E90FF |
| tpsSeries | Data for TPS graph | - |
| tpsMedium | Threshold for Medium TPS color (Config setting) | 7 |
| tpsLowColor | Color code for the graph color defined in the config | #XXXXXX |
| tpsHigh | Threshold for High TPS color (Config setting) | 14 |
| tpsMediumColor | Color code for the graph color defined in the config | #XXXXXX |
| tpsHighColor | Color code for the graph color defined in the config | #XXXXXX |
| cpuSeries | Data for CPU graph | - |
| ramSeries | Data for RAM graph | - |
| entitySeries | Data for Entities graph | - |
| chunkSeries | Data for Chunk graph | - |
| activityPieColors | Colors for Activity pie defined in the config | "#XXXXXX", "#YYYYYY", ..., "#ZZZZZZ" |
| active | Number of players considered "Active" | 432 |
| inactive | Number of players considered "Inactive" | 543 |
| joinLeaver | Number of players who have joined once | 435 |
| banned | Number of players who are banned | 44 |
| worldSeries | Data for Total WorldPie on Sessions tab | - |
| gmSeries | Drilldown data for Total WorldPie on Sessions tab | - |
| geoMapSeries | Data for Geolocation map | - |
| punchCardSeries | Data for Puchcard Graph | - |
| sessionTabGraphViewFunctions | JavaScript method calls to draw Session tab WorldPies | - |