diff --git a/Modrinth-Description.md b/Modrinth-Description.md new file mode 100644 index 0000000..41dafb8 --- /dev/null +++ b/Modrinth-Description.md @@ -0,0 +1,49 @@ +**ScoreKeeper Plugin** + +ScoreKeeper tracks player scores in configurable buckets. Use it for event points, competitions, or other server-side scoring systems, and integrate it with other plugins through the public API. + +## Commands + +Players can omit an optional player name to target themselves. Console and RCON must provide a player name for score get/add/subtract/reset commands. + +* `/score-get [playerName]` - Displays the target player's score in their active bucket. +* `/score-add ` - Adds an amount to your score in your active bucket. +* `/score-add ` - Adds an amount to the target player's score. +* `/score-subtract ` - Subtracts an amount from your score in your active bucket. +* `/score-subtract ` - Subtracts an amount from the target player's score. +* `/score-reset [playerName]` - Resets the target player's active-bucket score to that bucket's initial value. +* `/score-archive` - Archives and resets your score in your active bucket. +* `/score-archive ` - Archives and resets the target player's score in their active bucket. +* `/score-archive all` - Archives and resets scores in every bucket. +* `/score-archive bucket ` - Archives and resets every score in one bucket. +* `/score-archive-list` - Lists saved archive IDs, newest first. +* `/score-archive-list ` - Displays the saved scores in one archive. +* `/score-bucket` - Displays your active bucket. +* `/score-bucket ` - Switches your active bucket. +* `/score-bucket create [reporting]` - Creates a bucket. Reporting can be `admin`, `global`, `player`, or `none` (default). +* `/score-bucket ` - Switches a player's active bucket. +* `/score-bucket all ` - Changes the server's default bucket and clears individual bucket assignments. +* `/score-run start target ` - Starts a run that ends when a score reaches the target. +* `/score-run start duration