- Author AuroraLS3
- Creation date
- Featured
Change log 5.6 build 2883
This release brings redesigned join address visualization, Folia support, updates to Fabric 1.20.5, quality of life features and fixes some bugs.
Special thanks to jhqwqmc, Sniper_TVmc, mcmdev, DrexHD and ZhangYuheng for contributions to this update
Change log
Fabric
Folia
- Fabric support was updated to 1.20.5 by DrexHD, older fabric versions are no longer supported as Fabric 1.20.5 requires Java 21
Config
- Folia support was implemented by ZhangYuheng. Please note that sessions from Folia servers will have incorrect world times on Folia since the platform doesn't support PlayerWorldChangeEvent yet.
Website
- You can now configure Plan using environment variables. This can be useful for those running servers in docker environments. Examples:
- Plugin.ServerName -> PLAN_PLUGIN_SERVERNAME
- Database.MySQL.Password -> PLAN_DATABASE_MYSQL_PASSWORD
- ServerInfoFile.yml is also supported, eg. PLAN_SERVER_ID, PLAN_SERVER_UUID to have specific servers keep their identity if your server destroys all files on shutdown.
- With string lists variable needs to be format "- One\n- Two" where \n is newline
Redesigned Join Address visualization
Join address visualization was difficult for servers with 100s of join addresses. With the redesign you can select multiple addresses as a group to be visualized, and rename it to your liking. This can help you track different advertising campaigns and server list entries across time.
The same selectors are used on the Player Retention graph when you are grouping registered players by Join Address.
The address groups you make are linked to your user if you have login enabled, or stored to browser localstorage to keep them even if you close the page.
In addition:
Editing Queries
- It is now possible to disable join address gathering in the config
- It is now possible to filter out specific addresses from the data in the config. This can help if you have a geyser server that isn't configured to forward hostnames, since the geyser server IP would appear in the data instead.
- Join addresses that don't look like IPs or domains are now automatically filtered out. You can disable this behavior with Preserve_invalid setting.
Commands
- You can now press 'Edit Query' on the Query Results page to change the filters and view. This can be useful if you want to quickly select a timeframe from calendar and then filter the results further with other filters.
Database
- Fixed permissions not being checked for tab completion of commands which allowed players to get list of player names via tab completion.
Export
- Fixed duplicate key exception during enable in some rare cases related to UpdateWebPermissionsPatch
- Fixed CorrectWrongCharacterEncodingPatch failing on mysql.user table being a view
- Fixed error storing access log when IP was spoofed (Longer than IPv6)
Placeholders
- Fixed allowlist bounces data not being visible on exported pages.
Extensions
- Added %plan_server_uptime% placeholder
Locale
- Composite punishment support was added to LibertyBans Extension by mcmdev
- You can now configure PlaceholderAPI values that you want to ignore from other plugins. This is useful if some plugin doesn't report placeholder value after player leaves the server.
- Placeholders that aren't replaced are now no longer stored as a changed value.
- French (FR) locale was updated by Sniper_TVmc
- Simplified Chinese (CN) locale was updated by jhqwqmc
5.6 build 2816
This version brings a lot of bugfixes, such as Geolocation database download changes, and some new features, such as CSV export, whitelist bounce gathering and more placeholders.
Special thanks to jhqwqmc, Vankka, Beniro, liuzhen932 and SlimeDog for contributions to this update!
Change log
Data Gathering
Allowlist bounces
- Plan now downloads geolite database from playeranalytics.net - This is related to MaxMind reducing their daily download counts to 30/day by March 21st which breaks the geolocation database downloading. This means the geolocation database needs to be distributed via a server rather than from MaxMind directly. Currently Plan implicitly trusts that the webserver responding from geodb.playeranalytics.net is correct one. In future there will be a signature check added to ensure Plan is talking to correct server.
- Fixed server crash when using SQLite and Plan tried to gather installed plugin list on the server thread.
Spigot, Sponge & Nukkit servers now gather whitelist bounces. There is a new tab on the server page under Online Activity which allows you to quickly see whose login has been blocked by whitelist, and who you have already allowed on the whitelist based on session data, so that you don't do unnecessary work allowing them again.
Visibility is controlled with web permission page.server.allowlist.bounce
Website
CSV Export in tables
You can now export CSV from most tables. This is especially useful when combined with Query features, such as the click-and-drag in calendar for selecting data from specific timeframe.
Other
Webserver
- The react bundle is now built using Vite. It utilizes modules available in modern browsers. This sped up build times by 7 minutes and should also improve page loading speed.
- Fixed some issues where reverse proxied Plan website loaded a blank page
- Fixed issue where server players online graph was fetched for network page due to bad cache lookup
- Server & Network Overview now uses frontend formatting for playtime and dates
- Fixed issue where server ping table never loaded
- Fixed server calendar being editable (You could drag blocks around rather than select)
- Fixed ping graph not rendering on player page if there was a lot of points
Database
- Added simple DDoS protection that limits requests if same IP requests same path multiple times. This type of DDoS has become more prevalent against cloudflare IPs, where a Go-http-client based bot requests / repeatedly and doesn't follow redirects. Because browsers follow redirects this doesn't affect regular users.
Fabric 1.20.4
- Optimized how database handles transactions on disable. More unnecessary transactions are dropped
Placeholders
- Binero implemented Fabric 1.20.4 support, 1.20.3 is not supported this build onwards.
- Fabric command registration was moved earlier to avoid confusion when /plan reload doesn't exist after failed enable.
Commands
- Added network_ equivalent to all missing server_ placeholders
- Added %plan_regular_players% and %plan_network_regular_players% placeholders
- Added %plan_join_address% placeholder
- Fixed off-by-one error in %plan_top_...% placeholders where 0 would be top 1 and 9 top 10. Now it matches documentation where 1 -> 1, and 10 -> 10. If you were compensating for this bug you may need to change %plan_top_..._0% to %plan_top_..._1% etc
Export
- /plan ingame now shows Last join address of the player.
Extensions
- Fixed react files getting exported even when all export is disabled.
Locale
- Vankka updated DiscordSRV Extension to fix an incompatibility with new DiscordSRV version
- @Conditional values are now removed when the value of the boolean changes in a way that unsatisfies the condition.
- Fixed FastLogin Extension recording "Unknown" when behind a proxy server
- Fixed Quests Extension support for Quests version 5, version 4 is no longer supported.
- jhqwqmc updated Chinese locale (CN)
- liuzhen932 updated Chinese locale (CN)
Web User Access-Control - Change log 5.6 build 2614
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: https://github.com/plan-player-analytics/Plan/wiki/Migration-guide-from-Version-5.5-to-5.6
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.
Change Log
Web user access control (HTTPS required)
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 https://github.com/plan-player-analytics/Plan/wiki/Web-permissions 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.
Plugin Version History (HTTPS required)
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.
Click to see Who
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
Website
New features
Improvements
- Player tables now show Average, Best and Worst Ping for all players
- You can now choose visible columns on any table (such as Players tables and plugin tables.)
- Network Calendar was added to Network Overview, similar to Server Calendar
- Navigation button can now go to Plan Error Logs and Swagger Docs
- The bigger features mentioned above
Removal of old frontend files
- Network Performance now disables TPS, Entities and Chunks buttons if there's only Proxy servers in the selected dataset.
- Player page Plugins navigation now only shows servers that the player has data from.
- Fixed some table text color issues, especially in Night Mode
- Fixed issues with reverse-proxy https falling back to relative addresses in frontend when proxy-mode https was not in use. (Plan would assume address is http:// but browser would have https://, leading to different start for the address, which was interpret as incorrect address.)
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: https://github.com/plan-player-analytics/Plan/wiki/Html-Customization--migration-guide-to-React
PageExtension API changes
- Removed Plugin.Use_Legacy_Frontend setting.
- Removed any code related to this setting, old behavior and the old web files.
- Moved most html rendering from backend to the frontend.
- DataTables did not support rendering React inside table headers so the library was removed and all functionality used by Plan rewritten in React. The visual differences should be minimal.
Webserver
- You can now use web permissions with WebUser
- Registering custom web permissions is possible either by overriding Resolver#usedWebPermissions, or through ResolverService#registerPermissions. There are two methods in ResolverService, one which grants existing groups the new permissions based on existing permission.
Endpoint changes
- Address of any webserver that is enabled can now be used by commands (Useful for users with 2 game servers without proxy)
- Disabled X-Forwarded-For reverse-proxy warning temporarily since it was giving false positive warnings often.
- Fixed out of date information appearing on the /player page due to HTTP caching
Database
- Added /v1/preferences and /v1/storePreferences endpoints that has some default formatting values coming from config.yml and user specific preferences if they have them set. Preferences UI is not yet implemented so for now this only returns the defaults.
- Deprecated /v1/players endpoint, replaced with /v1/playersTable which gives data in raw format instead of formatted.
- Added Group Management related endpoints /v1/webGroups, /v1/groupPermissions, /v1/permissions, /v1/saveGroupPermissions, /v1/deleteGroup (Only enabled with https)
- Added Plugin history endpoint /v1/pluginHistory (Only enabled with https)
Spigot
- Fixed join address truncation error on backup
- Added tables plan_web_group, plan_web_group_to_permission, plan_web_permission, plan_web_user_preferences & plan_plugin_versions
- plan_security column permission_level was removed and a foreign key column group_id added
- Inactive player cleaning is now disabled on Game servers if Proxy server is in the database to avoid confusing situations where limit configured on Proxy server doesn't apply.
Fabric
- Possibly fixed Ping not being gathered on Spigot 1.20+ servers
- Dreeam-qwq fixed an error that occurred when Join Address didn't contain a port number.
Sponge
- Fabric 1.20.2 support was implemented by Kopo. Older versions of fabric are no longer supported.
- Plan now uses semantic version for fabric metadata
Locale
- ToxiWoxi fixed SpongeForge failing to load Plan due to unspecified LuckPerms dependency version in Plan
Some functionality was added to make life of translators easier.
Placeholders
- Added setting which lists untranslated keys Plugin.Logging.Log_untranslated_locale_keys (default false). This lists anything that has default value so it may give some false positives.
- Custom locale.yml file is now reloaded when it is modified.
- Ukranian Locale (UK) added by xlanyleeet
- Japanese Locale (JA) updated by yu_solt and Jumala9163
- Simplified Chinese Locale (CN) updated by jhqwqmc
- Translation of some data was moved to frontend so that it changes when you change the language.
Extensions
- Fixed off by one mistake in %plan_top_...% placeholders where 1 would give the 2nd highest and 10 nothing.
- Added %plan_player_geolocation% placeholder
- Fixed BuyCraft not sorting dates correctly
- Fixed an issue where rapid fire Vulcan AntiCheat violations would cause database exceptions.
- Updated Lands API to newer version
- Possibly fixed an issue where Litebans data was not being updated
- Fixed issue where ViaVersion would show no data on network page
5.5 build 2307
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.
Change log
Player Retention Analysis Graph
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.
- Draw graphs at different time resolutions
- Limit input data by time
- Group players by register date or join address
- Visualize player retention in different ways
- Time since registration date
- Playtime
- Date
- Cumulative player gain
- Percentage / Player count / Stacked player count
Data gathering
Website
- Attempt to correct register dates if they report a date in the year 1970 (Epoch millisecond 0 = Jan 1 1970).
Extensions
- Any extension tables can now be sorted
- Fixed Network > Servers Overview Quick view graph not loading
- Fixed sidebar being transparent in nightmode on mobile
- Fixed Activity index help modal not drawing the index function after certain x threshold
- Fixed data not updating when switching from Server to Network page in cases where they shared same components (eg. Playerbase graphs, Join address graphs, etc)
- Improved player overview card layout on mobile
- Reduced font size on mobile when in portrait mode, so that more tables remain readable
Locale
- Fixed NPE when player joined and FloodGate had not loaded its API
- TheLittle_Yang updated Traditional Chinese (CN) Locale
5.5 build 2272
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 https://github.com/plan-player-analytics/Plan/wiki/Html-Customization--migration-guide-to-React - 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.
Change log
React Frontend (Previously called Frontend BETA)
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:
- Faster loading time since less data requests are made at once
- Improved mobile navigation
- New features
- Page navigation button for switching between pages
- Switching language on the frontend
- Join address tab
- Visualizer switches for some graphs
- Average players online data to Performance tabs
- Interactive '?' help for Activity Index and New Player Retention (These were the two most common questions on how they work)
- Redesigned Network > Servers tab
- Easier to maintain and develop further
New feature: public_html
- Added a page navigation button that allows moving to different servers and other pages easily. This replaces the 'Back to main page' button. You can switch between the same page for two servers (eg. Move from Server 1 > Performance to Server 2 > Performance in one click)
- Improved mobile navigation. With the navigation button this should help mobile users a lot.
- Interactive '?' help for Activity Index and New Player Retention (These were the two most common questions on how they work)
- Fixed network server list saying "No servers installed" while servers were being loaded.
- Fixed page translation issues
- React was updated to version 18
- Javascript APIs for extending the page programmatically were implemented https://github.com/plan-player-analytics/Plan/wiki/APIv5-PageExtension-API#javascript-api
- Fixed join address data breaking the page when visualized as a table
- Fixed issues of plugin cards overlapping when switching between plugins of two servers on player page
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 https://github.com/plan-player-analytics/Plan/wiki/Html-Customization
Webserver
Database
- Implemented HTTP Caching: Browser will now cache some responses and avoid sending unnecessary data if it was already loaded. This can improve page loading times from multiple seconds to milliseconds.
- Implemented public_html feature that allows hosting custom files from a configurable folder Webserver.Public_html_directory (default /plugins/Plan/public_html). This can be used to host http-challenge file for certbot and other files.
PlaceholderAPI
- PlayerTableRowPatch should no longer be re-applied all the time
- Optimized server player table query: /server/players now loads much faster. Tested optimization: 4s -> 500ms: 8x improvement
- Optimized server latest join addresses query: /sever/join_addresses now loads much faster. Tested optimization: 19s -> 150ms: 120x improvement
- Optimized /v1/network/servers endpoint, got a 66% speed increase, so Servers tab on network page should load faster.
- Unregister placeholder extension when Plan disables: this possibly fixes an issue where PlaceholderAPI would log errors when Plan disabled before PlaceholderAPI.
