mirror of
https://github.com/brandon-rozek/wordguess
synced 2024-11-21 20:46:28 -05:00
Added readme
This commit is contained in:
parent
e3326dea9f
commit
f08e875b27
1 changed files with 40 additions and 0 deletions
40
readme.md
Normal file
40
readme.md
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
# 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`.
|
||||||
|
|
Loading…
Reference in a new issue