Files
ToolStats/README.md
hyperdefined 8fe7292505 1.9.10
2025-11-05 17:20:57 -05:00

50 lines
3.6 KiB
Markdown

<h1 align="center">ToolStats</h1>
<p align="center">
<a href="https://modrinth.com/plugin/ToolStats"><img alt="modrinth" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg"></a>
<a href="https://hangar.papermc.io/hyperdefined/ToolStats"><img alt="hangar" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/hangar_vector.svg"></a>
<a href="https://papermc.io"><img alt="paper" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/supported/paper_vector.svg"></a>
<a href="https://docs.hyper.lol/plugins/toolstats/about/"><img alt="ghpages" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/documentation/ghpages_vector.svg"></a>
<a href="https://discord.gg/rJuQXVcJz8"><img alt="discord-singular" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/social/discord-singular_vector.svg"></a>
<a href="https://buymeacoffee.com/hyperdefined"><img alt="buymeacoffee-singular" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/donate/buymeacoffee-singular_vector.svg"></a>
<a href="https://patreon.com/hyperdefined"><img alt="patreon-singular" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/donate/patreon-singular_vector.svg"></a>
</p>
ToolStats is a Paper plugin that display various stats about tools. This plugin is inspired off of [GearStats](https://www.spigotmc.org/resources/gearstats.12960/). You can either track all statistics by default, or a use a token system to add statistics to tool/armor. You can configure how each statistic is shown on the item, or disable it!
Here is everything it tracks:
* Blocks mined (pickaxes, shovels, axes, hoes, shears).
* Crops mined (hoes).
* Player/mob kills (swords, axes, tridents, bows/crossbows, mace).
* Ownership of items when crafted, looted (from chests/vaults/barrels), traded, spawned via creative, and caught from fishing.
* Armor damage taken.
* Damage done with weapons.
* Fish caught.
* Sheep sheared.
* Arrows shot (bows/crossbows).
* Flight time with elytras.
The best part is, this data is stored on the item itself.
If item lore is ever incorrect/missing, you can run `/toolstats reset`. This command fixes the lore on whatever item you are holding.
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image2.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image3.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image4.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image5.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image6.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image7.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image8.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image9.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image10.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image11.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image13.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image14.png)
![Image](https://docs.hyper.lol/plugins/toolstats/assets/image12.png)
## Documentation
Visit the [wiki](https://docs.hyper.lol/plugins/toolstats/about/) for help.
## License
This plugin is released under GNU General Public License v3. See [LICENSE](https://github.com/hyperdefined/ToolStats/blob/master/LICENSE).