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:00:25 -05:00
parent ead3f65016
commit 92368adfbf
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Token-System.md

@@ -3,6 +3,9 @@ The token system is a way for players to add stats to items they want. Players e
## Setup
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
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.
@@ -20,6 +23,13 @@ If you want to use commands, you can use `/toolstats givetokens <player> <token-
|---|---|---|
| ![flight-time](https://raw.githubusercontent.com/hyperdefined/ToolStats/refs/heads/master/images/crafting/flight-time.png) | ![arrows-shot](https://raw.githubusercontent.com/hyperdefined/ToolStats/refs/heads/master/images/crafting/arrows-shot.png) | ![damage-taken](https://raw.githubusercontent.com/hyperdefined/ToolStats/refs/heads/master/images/crafting/damage-taken.png) |
## Use Tokens
## Using Tokens
To use a token, simply apply it in an anvil like below. You can configure how many levels it takes for each in the config.
![anvil](https://raw.githubusercontent.com/hyperdefined/ToolStats/refs/heads/master/images/crafting/anvil.png)
## 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).
Apply it like any other token.
![reset-token](https://raw.githubusercontent.com/hyperdefined/ToolStats/refs/heads/master/images/crafting/reset-token.png)