wordguess/readme.md

58 lines
1.2 KiB
Markdown
Raw Normal View History

2024-01-06 13:58:52 -05:00
# WordGuess
Daily pubnix game where you guess the word of the day.
Compare your word chops with other people on the same
server!
## Server
Make sure that the WordGuess folder is accessible
to other users.
This means that if the code lives
in `/home/wg/WordGuess` then the executable permission must
be given to `/home/wg`.
```bash
chmod o+x /home/wg
```
The server code will adjust the permissions of all the other files
to circumvent cheating.
To run the server
```bash
python server.py
```
You should see an output such as
```
Successfully loaded game state
Seed: 701625
Started server at /home/wg/WordGuess/game.sock
```
Don't share the seed with anyone! Otherwise they can
figure out the word for all future days.
You can reset the seed and all game state by removing the file `state.pickle`.
2024-01-06 13:59:29 -05:00
## 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`.