From 526b4c577144ffbbf22c383d0bb5e19e5d7e60de Mon Sep 17 00:00:00 2001 From: Oliver-Akins Date: Sat, 25 Dec 2021 23:58:16 -0700 Subject: [PATCH] Add a document detailing all the events that the client will send to the server --- server/events.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 server/events.md diff --git a/server/events.md b/server/events.md new file mode 100644 index 0000000..a3074e2 --- /dev/null +++ b/server/events.md @@ -0,0 +1,34 @@ +This is a list of all events that the server must support in order at the bare +minimum for the front-end to work with getting all the data that it needs. + +--- + +`get.game` +Get's a game's current information, this includes player list, and options + +--- + +`delete.game` +Deletes a game from the system, kicking all the players from the lobby. + +--- + +`get.system.colours` +Retrieves a list of all colours that are currently supported for players to pick +from for their spaceship. + +`get.system.icons` +Retrieves a list of all the supported icons that players can pick from for their +spaceship. + +--- + +`put.player.design` +Updates a player's design that will be used in the game for their spaceship. + +--- + +`put.game.option` +Updates the game's options that affect how the game flow works. + +--- \ No newline at end of file