From ed48b121a984d539b9d880ea475a33d1f40ec536 Mon Sep 17 00:00:00 2001 From: Artemis-the-gr8 Date: Tue, 31 May 2022 20:08:09 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dd1357b..e5708a3 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,33 @@ ## First Time Use -## Features +## Features +* **Easy to use** + - One central command that can: + - Show you the **top 10** on your server for all possible statistics + - See those same statistics for any **individual player** + - Guide you through the available options while you type with an extensive **tab-complete** feature + +[Top_10](src/main/resources/images/.png) +[Player_Stat](src/main/resources/images/.png) +[Tab_Complete](src/main/resources/images/.png) + +* **No set-up required** + - PlayerStats will work correctly regardless of how long your server has already existed - it doesn't + have to be present when you start a new world + - Data is retrieved directly from already existing playerfiles, so you don't have to + set up a database, use scoreboards, or anything of the sort + + +* **Safe** + - PlayerStats uses **multi-threading** to ensure server performance does not suffer and + players cannot crash the server by spamming its commands + +* **Customizable** + - Many options + +## Disclaimer +For big servers... ## Author Info I am a relatively new programmer, and this is one of my first projects. I greatly enjoyed making it, @@ -12,5 +38,5 @@ please let me know! You can find me on [GitHub](https://github.com/Artemis-the-g or reach me by email: artemis.the.gr8@gmail.com ## Licence -RegenAssist is licenced under the MIT licence. Please see [LICENCE](LICENSE) for more information. +PlayerStats is licenced under the MIT licence. Please see [LICENCE](LICENSE) for more information. From dc36f8473f6d79e2f73a03e95dfc6f20ef243757 Mon Sep 17 00:00:00 2001 From: Artemis-the-gr8 Date: Tue, 31 May 2022 21:00:45 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 40 ++++++++++++++++++++++++++++++++++++---- 1 file changed, 36 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e5708a3..78c0f84 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,18 @@ ![PlayerStats_Logo](src/main/resources/images/logo.png) ## About +PlayerStats is a Minecraft server plugin that adds a command to view player statistics in +top-10 format or individually. Currently supports version **1.18.2** on platforms: +- Bukkit +- Spigot +- Paper +- Purpur ## First Time Use ## Features * **Easy to use** - One central command that can: + - Explain **how to use** the plugin with /statistic - Show you the **top 10** on your server for all possible statistics - See those same statistics for any **individual player** - Guide you through the available options while you type with an extensive **tab-complete** feature @@ -20,16 +27,41 @@ - Data is retrieved directly from already existing playerfiles, so you don't have to set up a database, use scoreboards, or anything of the sort - * **Safe** - PlayerStats uses **multi-threading** to ensure server performance does not suffer and - players cannot crash the server by spamming its commands + players cannot crash the server by spamming its commands + - This also means that for small to medium-sized servers, calculating statistics will be very *fast* + For large servers (1000+ players), please read the disclaimer below * **Customizable** - - Many options + - You can customize the following: + - Only show statistics for *whitelisted* players + - Exclude statistics from *banned* players + - Limit statistics based on when a player *last joined* + This option can be particularly useful if you have had a lot of players join your server in the past + whose statistics aren't of particular interest to your current player-base. + On top of that, limiting the amount of players shown in the top 10 will greatly increase performance speed. + - The *colors* you want the output to be + - Whether you want the output to have additional *style*, such as italics ## Disclaimer -For big servers... +How PlayerStats performs, will heavily depend on the amount of unique players that have joined +your server, and on the specs of the machine it is running on. I have done elaborate testing on +my local server, and it is currently also running on the SMP I play on. Lookup up an individual +statistic is always nearly instant, but for a **top statistic** it can vary. + +With roughly 110 unique players, it takes about 0.1 seconds to calculate a top statistic on the SMP. +With 110 unique players, my laptop takes 0.3 seconds. +With 1000 unique players, my laptop takes about 5 seconds. +With 5000 unique players, it takes 30 seconds. +(A beefy PC could do this much faster, of course.) + +I have tried to make the plugin as fast and effecient as possible, but I have not tested it with more than +10.000 playerfiles. Although spamming the command had no impact on the server TPS, I do not know if +it would have other effects (mainly CPU usage, I am guessing). So if you want to use this plugin on servers +with a lot of unique players, I recommend limiting the amount of included players by setting a +number-of-days-since-last-joined limit in the config, and use caution. I do want to improve +performance in the future though, and I'd love to hear feedback on how the plugin is performing! ## Author Info I am a relatively new programmer, and this is one of my first projects. I greatly enjoyed making it, From c31ee0be8017b15d5a877e7aaa0ffd24d60eadef Mon Sep 17 00:00:00 2001 From: Artemis-the-gr8 Date: Tue, 31 May 2022 21:09:58 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 78c0f84..85bc293 100644 --- a/README.md +++ b/README.md @@ -30,19 +30,22 @@ top-10 format or individually. Currently supports version **1.18.2** on platform * **Safe** - PlayerStats uses **multi-threading** to ensure server performance does not suffer and players cannot crash the server by spamming its commands - - This also means that for small to medium-sized servers, calculating statistics will be very *fast* + - This also means that for small to medium-sized servers, calculating statistics will be very **fast** For large servers (1000+ players), please read the disclaimer below * **Customizable** - You can customize the following: - - Only show statistics for *whitelisted* players - - Exclude statistics from *banned* players - - Limit statistics based on when a player *last joined* + - Only show statistics for **whitelisted** players + - Exclude statistics from **banned** players + - Limit statistics based on when a player **last joined** This option can be particularly useful if you have had a lot of players join your server in the past whose statistics aren't of particular interest to your current player-base. On top of that, limiting the amount of players shown in the top 10 will greatly increase performance speed. - - The *colors* you want the output to be - - Whether you want the output to have additional *style*, such as italics + - The **colors** you want the output to be + - Whether you want the output to have additional **style**, such as italics + - You can configure the following **permissions**: + - `playerstats.stat` for using the general command (true for everyone by default) + - `playerstats.reload` for reloading the config (only for OP players by default) ## Disclaimer How PlayerStats performs, will heavily depend on the amount of unique players that have joined @@ -57,8 +60,8 @@ With 5000 unique players, it takes 30 seconds. (A beefy PC could do this much faster, of course.) I have tried to make the plugin as fast and effecient as possible, but I have not tested it with more than -10.000 playerfiles. Although spamming the command had no impact on the server TPS, I do not know if -it would have other effects (mainly CPU usage, I am guessing). So if you want to use this plugin on servers +10.000 playerfiles. Although spamming the command had no impact on the server TPS, I don't know if +it could have other effects (mainly CPU usage, I am guessing). So if you want to use this plugin on servers with a lot of unique players, I recommend limiting the amount of included players by setting a number-of-days-since-last-joined limit in the config, and use caution. I do want to improve performance in the future though, and I'd love to hear feedback on how the plugin is performing! From 542a41b7def51ddc081a9b759d5baa8aafa70c6f Mon Sep 17 00:00:00 2001 From: Artemis-the-gr8 Date: Tue, 31 May 2022 21:37:38 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 85bc293..fc8b1d9 100644 --- a/README.md +++ b/README.md @@ -7,19 +7,17 @@ top-10 format or individually. Currently supports version **1.18.2** on platform - Paper - Purpur -## First Time Use - ## Features * **Easy to use** - One central command that can: - - Explain **how to use** the plugin with /statistic + - Explain **how to use** the plugin with `/statistic` - Show you the **top 10** on your server for all possible statistics - See those same statistics for any **individual player** - Guide you through the available options while you type with an extensive **tab-complete** feature -[Top_10](src/main/resources/images/.png) -[Player_Stat](src/main/resources/images/.png) -[Tab_Complete](src/main/resources/images/.png) +[Top_10](src/main/resources/images/top_10.png) +[Player_Stat](src/main/resources/images/player_stat.png) +[Tab_Complete](src/main/resources/images/tab_complete.png) * **No set-up required** - PlayerStats will work correctly regardless of how long your server has already existed - it doesn't @@ -31,13 +29,13 @@ top-10 format or individually. Currently supports version **1.18.2** on platform - PlayerStats uses **multi-threading** to ensure server performance does not suffer and players cannot crash the server by spamming its commands - This also means that for small to medium-sized servers, calculating statistics will be very **fast** - For large servers (1000+ players), please read the disclaimer below + For large servers (1000+ players), please read the disclaimer below -* **Customizable** +* **Customizable** - You can customize the following: - Only show statistics for **whitelisted** players - Exclude statistics from **banned** players - - Limit statistics based on when a player **last joined** + - Limit statistics based on when a player **last joined**. This option can be particularly useful if you have had a lot of players join your server in the past whose statistics aren't of particular interest to your current player-base. On top of that, limiting the amount of players shown in the top 10 will greatly increase performance speed. @@ -74,4 +72,3 @@ or reach me by email: artemis.the.gr8@gmail.com ## Licence PlayerStats is licenced under the MIT licence. Please see [LICENCE](LICENSE) for more information. -