Added description for players

This commit is contained in:
Brandon Rozek 2024-01-06 13:59:29 -05:00
parent f08e875b27
commit 4a3e71fd66
No known key found for this signature in database
GPG key ID: 26E457DA82C9F480

View file

@ -38,3 +38,20 @@ figure out the word for all future days.
You can reset the seed and all game state by removing the file `state.pickle`.
## Players
Players can play the game by running the `client.py` python script.
If the game lives under `/home/wg/WordGuess` then the command will be
```bash
python /home/wg/WordGuess/client.py
```
After playing the game, the server will record the users high score.
They can see the leaderboard by running
```bash
python /home/wg/WordGuess/leaderboard.py
```
You can also pass a date with `--date`.