From 4a3e71fd66e9e85b62aec7628885385709564182 Mon Sep 17 00:00:00 2001 From: Brandon Rozek Date: Sat, 6 Jan 2024 13:59:29 -0500 Subject: [PATCH] Added description for players --- readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/readme.md b/readme.md index 74e4f57..6455621 100644 --- a/readme.md +++ b/readme.md @@ -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`.