Updates documentation and adds scripts to start/stop the server.

This commit is contained in:
Tom Hicks
2025-07-13 23:58:29 -07:00
parent 10830a7de7
commit 76bdc64e2b
7 changed files with 350 additions and 12 deletions

21
README.md Normal file
View File

@@ -0,0 +1,21 @@
# ScoreKeeper Plugin
## Running
### Commands
* `/score-get [playerName]` - Displays the player's score.
* `/score-add [playerName] <amount>` - Add amount points to the player's score.
* `/score-subtract [playerName] <amount>` - Subtracts amount points from the player's score.
* `/score-reset [playerName]` - Resets the player's score to 0.
* `/score-archive [playerName]` - Saves the player's score to a "High Scores" table and resets their current score to 0.
NOTES:
* All commands will use the executing player in place of [playerName] if it is omitted.
* Permissions support is coming AFTER I get archive to work.
* The commands aside from get are intended for admins and whatnot as some other plugin should be using the methods instead of letting player's execute commands.
## Development
See [CONTRIBUTING.md](CONTRIBUTING.md) for development environment setup instructions.