DocRock3r/ToolStats
1
0
Fork 0
mirror of https://github.com/hyperdefined/ToolStats.git synced 2025-12-10 14:44:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Token System (markdown)

hyperdefined
2025-01-26 17:08:42 -05:00
parent 92368adfbf
commit 281e515abd
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Token-System.md

@@ -1,11 +1,15 @@
The token system is a way for players to add stats to items they want. Players either craft or are given a token to add to an item. Once added, that tool will track that given statistic. Once this system is on, all stats will be turned off unless the player's tool/armor has a token applied. The token system is a way for players to add stats to items they want. Players either craft or are given a token to add to an item. If this system is enabled, all tools/armor will only track statistics once a token is applied to it. There are different tokens for different statistics.
However, origin of items will be tracked still. You can disable this in the `enabled` section of the config.
> [!CAUTION]
> READ ME PLEASE!!!!!!!!!!!!!<br>
It's recommended to either keep this enabled or disabled. Changing the setting after installing and using can break the plugin's functions. I recommend deciding what system you want first, sticking to it.<br><br>
This is not an issue when you first install the plugin. But changing this setting later on can and will break. It can lead to tools not tracking stats correctly.
## Setup ## Setup
To enable, set `tokens.enabled` true in your config. I recommend setting up the tokens section before using on your server. To enable, set `tokens.enabled` true in your config. I recommend setting up the tokens section before using on your server.
> [!CAUTION]
> It's recommended to either keep this enabled or disabled. Changing the setting can break the plugin's functions. I recommend deciding what you want first, then installing. Installing on an existing world is fine, but decide if you want it disabled/enabled first. Changing it afterwards can lead to items not tracking or breaking.
## Obtaining Tokens ## Obtaining Tokens
Tokens be obtained by being crafted or given via commands. By default, tokens can be crafted. If you want to disable this, set `craft-tokens` to `false` in your config. Below are the crafting recipes. Tokens be obtained by being crafted or given via commands. By default, tokens can be crafted. If you want to disable this, set `craft-tokens` to `false` in your config. Below are the crafting recipes.
@@ -28,7 +32,7 @@ To use a token, simply apply it in an anvil like below. You can configure how ma
![anvil](https://raw.githubusercontent.com/hyperdefined/ToolStats/refs/heads/master/images/crafting/anvil.png) ![anvil](https://raw.githubusercontent.com/hyperdefined/ToolStats/refs/heads/master/images/crafting/anvil.png)
## Reset Token ## Reset Token
There is a special reset token, which will reset the tracked stats of an item. This does *NOT* remove the tokens on the item, but sets the values to zero. This also does not remove the origin of the item (crafted, traded, etc). There is a special reset token, which will reset the tracked stats of an item. This does *NOT* remove the tokens on the item, but sets the values to zero. This also does *NOT* remove the origin of the item (crafted, traded, etc).
Apply it like any other token. Apply it like any other token.