A new version has been released for Plan, it is available for download here.
This release contains a hotfix for MySQL driver unloading issues on disable/reload, causing the plugin to spew a really long error message and failing to reload when using MySQL.
Driver is no longer unloaded during reload to avoid any issues.
This bug was introduced in dev build 1536 on January 6th, but it was not caught or reported.
A new version has been released for Plan, it is available for download here.
Hello! This update brings some great database optimizations, beginning of Frontend BETA (Opt-in), as well as small fixes.
Read more below
Sponge API 8 is coming soon, but the database schema changes in this update need to come first to not leave servers unable to update to Java 11 stranded.
This update is backwards incompatible due to database schema changes.
Servers with old Plan versions should not be enabled after starting a server with this update installed.How to prepare for this update
Networks: Make sure to update all servers that are connected to the database!
If an old version starts with the new database schema it will attempt to reverse some of the new changes.
Special thanks to Kopo, Pingger & KasperiP for contributions to this update.
A lot of work was put into analyzing bottlenecks in queries and slow query logs sent in by users.
Benchmarks using 17k players are promising, as /players page now loads in 5s vs 2+min before.
Database patches will apply on first enable of the update to modify the database schema. This can take up to 4 minutes. Networks: Only enable one Plan server and wait for it to patch database before starting other servers.
SELECT u.uuid ... JOIN plan_users u on u.id=<table>.user_idserver_id=(SELECT id FROM plan_servers WHERE uuid='<server uuid>')Frontend is being rewritten in React one page at a time. This is to have more control over what is displayed on the website, since a lot of requested features will require more interaction or hiding features partially. - While doable with vanilla javascript, code would quickly become unmaintainable.
The goal is to get feature parity with the current frontend implementation by rewriting one page at a time and then switch over completely.
Some features will not use React frontend until everything is complete.
Plugin.Frontend_BETA to trueKopo did a massive locale system improvement in order to support translations on the frontend side, implementing yml conversion, namespacing all of the existing locale keys and writing json endpoints for frontend to load locale - as well as the code responsible for loading those using i18next.
A new version has been released for Plan, it is available for download here.
This update brings a couple important bugfixes to build 1628. Please read change log of 1628 if youâre running older build than 1628.
A new version has been released for Plan, it is available for download here.
This update fixes some annoying bugs and prepares the plugin for the move to 5.5 and Java 11 while keeping this version compatible for those unable to update their servers to Java 11.
If no further critical bugs surface next update will be 5.5.
A new version has been released for Plan, it is available for download here.
This update fixes fabric 1.19 support and join address gathering.
Special thanks to Kopo for contributions to this update.
An oversight in the way the player leave listener code was structured caused the player join address to be removed from memory before its linking to the session that was ending.
It is now fixed.
Kopo fixed fabric pipeline for 1.19 - Unfortunately the changes are incompatible with older versions of fabric. If you need older version of fabric use older version of Plan.
A new version has been released for Plan, it is available for download here.
This release contains update to Java 11, Sponge 8, Fabric 1.19.1, as well as Webserver rewrite to Jetty. In addition it contains new features and improvements, and more progress on Frontent BETA in the form of rewritten server & network pages.
Special thanks to Vankka, Kopo, Drex & stashenko for contributions to this update
This version updates config so backup your config in case you need to revert back to 5.4!
If you canât update, you can continue using 5.4 build 1722 even if connected to same database as newer versions. (No database schema changes!)
New webserver implementation speeds up response transmission times considerably
Access logs are now stored in Plan database in plan_access_log table.
Webserver.Security.Access_log.Print_to_console (default false) in the config. This is useful for debugging reverse-proxy issues.Webserver.Security.Access_log.Remove_logs_after_days (default 30)Plan json endpoints are now documented with Swagger available on the webserver itself. You can access the Swagger documentation from /docs on your Plan webserver after updating.
/plan db removejoinaddresses {servername} once you install the plugin.Enable with Plugin.Frontend_BETA setting in the config. Note that Html Customization and Export are not yet supported in the beta.
You can track progress of frontend beta here
/plan player .plan.command permission (default: true) on Spigot servers to allow hiding /plan command from tab completion by negating this permissionA new version has been released for Plan, it is available for download here.
A new version has been released for Plan, it is available for download here.
Special thanks to PikaMug for contributions to this update!
A new version has been released for Plan, it is available for download here.
This update contains small improvements.
Special thanks to DubHacker for contributions to this update.
A new version has been released for Plan, it is available for download here.
This release contains a lot of things. Frontend BETA enters next phase since all pages have been rewritten in React, next steps are export and html customization implementation for it. This update also contains data gathering fixes, additions, new placeholders along with other bugfixes.
Today also marks 6th year of Plan development! As is customary at this point thereâs a Year in Review -post after the change log.
Special thanks to Vankka, angela0930 for contributions to this update
Iâm excited, the frontend part of rewrite is complete and I can move to implementing export and html customization for the new frontend.
If your pluginâs data contains chat colors or mini-message information, that information can now be included so that it will eventually show up on the website. Check documentation for the new API here
Added new placeholders
This year has been a lot different from the previous five, since there has been a lot more things going on in my personal life. Last year I got a job, and in January I started writing my Masterâs thesis. It was very tough balancing all that on top of developing Plan on the side. I had to take some months off development entirely with a hiatus in the summer and fall to finish up the thesis. In September I returned the thesis for review and Iâm happy to now have graduated! Things definitely calmed down after finishing up the thesis and resuming Plan development after the hiatus.
The running theme this year has been steady and stable changes. Inspired by the answers to last yearâs poll, the goals for this year were to improve the loading speed of the website, as well as visualizing more of the gathered data.
Thereâs been a lot of work done this year towards those goals. The database schema was changed drastically, the webserver was changed to Jetty, and Frontend BETA is rewriting the code running in browser to React. Alone each change brings small improvements, but together they improve things a lot.
Iâm very excited for the future, since the React frontend speeds up development of new things considerably thanks to environment where changes can be seen instantly. Previously I would have had to compile Plan and restart the test server â It takes 1 second vs 3 minutes it used to take to see changes now.
Main goals for 2023 is to get the new frontend out of Beta after feature parity with previous frontend is reached (Export and Html Customization still to go), and after that itâll be time to tackle a lot of tickets with âVisualizationâ tag. A lot of the ongoing work has been done to make the future changes easier to do, which should speed up feature additions in the upcoming year.
Iâm very happy that all the automation created in the past years is now finally paying off, helping keep confidence in that everything works as intended when changing something. I love that itâs now possible to deliver development builds fast, even within the same hour when someone is asking for help.
Special thanks to Github sponsors, donators, discord moderators, support, and contributors this year! Extra special thanks to Kopo & Vankka for their constant input into the project.
This year in numbers
Have a good one! 
A new version has been released for Plan, it is available for download here.
Another release to add 1.19.3 support to Fabric and release all the goodies developed since previous update
Special thanks to DrexHD for contributions to this update.
/, further testing needed if your export is on /stats/ for example.)
A new version has been released for Plan, it is available for download here.
This build contains various bugfixes.
A new version has been released for Plan, it is available for download here.
This update contains a hotfix to build 2144. New installations after build 2100 are not affected - The bug affected instances that were updated from versions prior to build 2100 on networks or fabric servers. Sorry for any inconvenience it has caused. More about the bug below.
An unfortunate typo in session to join address id correction code caused all sessions to get invalid join address id. Instead of correcting invalid ids to correct ids, it changed correct ids to incorrect ids. Any installations where the broken patch ran lost their join address data.
Symptoms of the bad patch:
Fixes in this update:
A new version has been released for Plan, it is available for download here.
This update contains performance improvements and subdirectory support for the new frontend.
Export features are now complete, up next is Html Customization.
A new version has been released for Plan, it is available for download here.
This build contains a fix to a CRITICAL SQL Injection vulnerability, as well as fixes to minor security vulnerabilities.
Yesterday (2023-01-14): Finding a minor Path Traversal security vulnerability lead to a throughout process of labeling all untrusted data in the codebase, and during that process a critical SQL Injection vulnerability was also discovered. When exploited successfully SQL Injection allows a malicious actor to read any data from the database and change or delete data. This may expose user salted+hashed Plan web user passwords or other data in the database.
It is recommended to update as soon as possible, even though exploits for the vulnerability may not yet exist in the wild.
The fix has been backported to build 1722 Release 5.4 build 1722.1 ¡ plan-player-analytics/Plan ¡ GitHub for those that need it.
This is a first time a this high priority vulnerability affects Plan, so Iâm a bit overwhelmed, but Iâm hoping to address this vulnerability professionally by releasing a fix in a timely manner, and keeping exact details undisclosed for now to give users time to update.
Details
Vulnerable versions: 5.2 build 1168 to 5.5 build 2163
if login is enabled: Malicious users with permission level 1 (plan.player.other) or 0 (plan.server) can access an endpoint which was found to contain an SQL Injection vulnerability.
if login is not enabled: Any malicious actor can access an endpoint which was found to contain an SQL Injection vulnerability.
Webserver:
Security:
IP_whitelist:
Enabled: true
Webserver:
Disable_webserver: true
A new version has been released for Plan, it is available for download here.
This update enables the new React based frontend by default, speeds up loading various parts of the website, and fixes a couple of issues.
If you are using Html Customization, it is now possible to migrate to the new system, see Html Customization migration guide to React ¡ plan-player-analytics/Plan Wiki ¡ GitHub - You can use Plugin.Use_Legacy_Frontend setting until your migrations are complete.
Back up your config in case you need to revert to previous version. Updating should be easy, simply replace the jar.
The frontend rewrite is complete, so the new frontend is now enabled by default. Plugin.Use_Legacy_Frontend (default: false) setting still allows using old frontend for a while until itâs completely removed.
Here is a summary of improvements this brings if you have not participated in the Beta:
Changes from previous update:
A new feature in the webserver allows hosting any web files on the Plan webserver. Please note that any files placed in the public_html folder (/plugins/Plan/public_html by default) can be read by anyone who knows the address to the webserver even if you have login enabled. The folder can be configured with Webserver.Public_html_directory setting.
The main purpose of this feature is to allow Html Customization of the React bundle Html Customization ¡ plan-player-analytics/Plan Wiki ¡ GitHub
Webserver.Public_html_directory (default /plugins/Plan/public_html). This can be used to host http-challenge file for certbot and other files.A new version has been released for Plan, it is available for download here.
This release has some new tools for analyzing player retention, as well as further improvements to the website.
Special thanks to TheLittle_Yang for contributing to this update.
This update adds a graph to network and server pages (Playerbase > Player Retention) that has options to:
Any and all combinations are allowed which allows extensive analysis of player retention. Help sections attempt to make the data understandable and show examples.
A new version has been released for Plan, it is available for download here.
This is a feature packed update, as it brings support for multiple proxy servers, IP allowlist CIDR and Dynamic DNS support, Fabric 1.19.4, and lots and lots of improvements.
Special thanks to Kopo, WolverStones & inductor for contributions to this update!
Plan can now be installed on multiple proxy servers. This is useful for networks that divide their players between multiple proxy servers.
Known limitations: Online sessions/status are not synced on multiple proxies
A new version has been released for Plan, it is available for download here.
This update contains bugfixes. This is probably the last version that will support âPlugin.Legacy_Frontendâ setting. Version 5.6 will remove the old frontend code so migrate your html customizations to React as soon as possible.
Special thanks to DrexHD, lis2a & ringoXD for contributions to this update.
A new version has been released for Plan, it is available for download here.
Hello! This version contains a hefty set of new features, bugfixes and usability improvements. Highlighted features include Web User Access-Control, Plugin Version History and âClick to see Whoâ-features. There are a lot more new things so check out the change log.
Updating to this version modifies database schema
There is a guide for updating to this version here: Migration guide from Version 5.5 to 5.6 ¡ plan-player-analytics/Plan Wiki ¡ GitHub
Special thanks to yu_solt, ToxiWoxi, Kopo, xlanyleeet, Jumala9163, ringoXD, Dreeam-qwq & jhqwqmc for their contributions to this update!
If you would like to support the project financially, please consider sponsoring the main developer.
A more granular user access control has been requested for quite a long time. Now you can limit users to only see smaller parts of the website. This feature is documented in Web permissions ¡ plan-player-analytics/Plan Wiki ¡ GitHub though you will find some help embedded on the /manage page.
Migrating from old version with permission_level adds groups âlegacy_level_0â etc with permissions that match previous behavior, users are linked to them automatically.
In order to edit web permissions on the website you need to set at least one webuser as admin with /plan setgroup {username} admin.
In order to keep /plan register working, give your players âplan.webgroup.{group_name}â-permission in your permission plugin (such as LuckPerms) for the group you want them to have. If player has none of these permissions they canât register at all.
Plan now gathers plugin versions on server start. Any modifications are timestamped. This can be useful when tracking performance impact of plugin updates. This data was possible to gather from all server platforms.
Seeing this data on the website requires HTTPS to be set up because some server admins may consider this data sensitive. Without HTTPS the data endpoint is disabled and the data is only visible in the database. After HTTPS is set up admins can control who sees this data through web permissions.
On network page it is possible to check plugin versions of any server on the network. This can help you keep up to date with your plugins.
You can now click & drag on Server Calendar (and the new Network Calendar) to see who was playing on specific days the calendar data is about. On Geolocations Map you can click on a Country to see who has joined from that country.
These features utilize the existing Query features so it was relatively simple to implement. If you have more ideas where you would like to see who data is about, you can make a suggestions on Github
With the React rewrite being complete an in use by most users, this version deletes the old frontend files from the jar. This reduces jar size.
If you still havenât migrated your html customizations this version does not load them anymore. Migration guide: Html Customization migration guide to React ¡ plan-player-analytics/Plan Wiki ¡ GitHub
Some functionality was added to make life of translators easier.
