Updates documentation and adds scripts to start/stop the server.
This commit is contained in:
21
README.md
Normal file
21
README.md
Normal 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.
|
||||
|
||||
Reference in New Issue
Block a user