commit 3483356d265b64e5f8c4c9be11700c44d907f816 Author: Boyan Date: Thu Nov 2 14:58:21 2023 +0100 Pretty flowcharts added to README diff --git a/README.md b/README.md new file mode 100644 index 0000000..580bdb9 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Game Server +This is the platform from which one can host any "game" that they have defined. It's a sandbox for simplistic multiplayer games(like chess, tic tac toe, othello, etc.). + + +## Ideas +* Simple websockets connection between server and "players"(clients) +* Clients need to + * Authenticate (at a later point) + * Describe the protocol of the game that they're going to play to the server, which then gets compared and informs the players if there's a mismatch +* Simple web interface(list) of all current games +* Developed protocols, which clients can use. + +## TODOs +* [ ] Create websocket server +* [ ] Implement the description of the protocol from the client(s) + +## Flowcharts +### Creation +![Game creation](media/game_creation.png) + +### Preparation +![Game preparation](media/game_prep.png) diff --git a/media/game_creation.png b/media/game_creation.png new file mode 100644 index 0000000..0c1d9b8 Binary files /dev/null and b/media/game_creation.png differ diff --git a/media/game_prep.png b/media/game_prep.png new file mode 100644 index 0000000..6321810 Binary files /dev/null and b/media/game_prep.png differ