DISCLAIMER:
If you are not familiar with DBMS especially MySQL or MariaDB, this plugin is NOT for you.
If you are using Java 8 to 16 (Minecraft version 1.8 - 1.16.5), use version 2.0,
If you are using Java 17+ use latest version
I don't support Java <17 anymore
Additional Note:
(9 Dec 2021) This plugin is NOT affected by RCE 0-day exploit in log4j. Be sure to UPDATE your server jar (Spigot/PaperMC etc) IMMEDIATELY.
*) RCE: Remote Code Execution
*) log4j: A logger tool used by Minecraft
*) Mojang Developer official statement about this severe security read here
*) For Spigot read here
*) For PaperMC read here
*) In-depth explaination about this severe security issue read here
What is Zstats?
Zstats is a Spigot plugin to record all players statistics to MySQL database so you can display the stats live to your website, for instance like this:
Features:
- MySQL storage (using HikariCP, asynchronous and lag-free even on a potato PC)
- AFK time statistics, requires EssentialsX (optional)
- Notify a player stats update to Discord, requires DiscordSRV (optional)
- Auto update a player stats to database when the player leaves your server
- Flexible configurations, you can choose what stats to be recorded to your database
Compatibility:
- Spigot/PaperMC from 1.8 to 1.18
- Geyser and Floodgate
- Java 17 and newer
Other than that is not tested and not guaranteed.
Commands and Permissions:
All these commands require Zstats.use permission
/zstats update
Update all player stats to database (may takes long to finish depending on how many unique players ever joined your server)
/zstats update
Update specified player stats to database
For Minecraft version before 1.15, you can only update online players due to SpigotAPI doesn't support offline player yet.
/zstats delete
Delete specified player stats from database record (doesn't delete the player stats itself, only the database record)
Installation:
- Download and put the jar file to plugins folder
- Start and stop again your server to generate config file (you can also use load/unload command from PlugMan)
- Enter your MySQL details to config.yml
- Explore the config.yml file!
- Ready to be used (you can also reload this plugin with PlugMan)
Note:
This plugin is developed by myself in my free time for my personal SMP server need. If you need to add your own custom player stats to be recorded to database, you have to clone and change the code then recompile it by yourself from my GitHub repository (and pull request to my GitHub repository too).
If you find any bugs/issues please report them to my GitHub repository and I will fix them in my free time (no rush, no ETA).
Please credit me and give this plugin link if you post it to another website, thank you.