From 1fc2cf54055af5baf4e41979be671b82e98eb5df Mon Sep 17 00:00:00 2001 From: Oliver-Akins Date: Wed, 16 Dec 2020 16:18:05 -0700 Subject: [PATCH] Add Game type. --- server/types.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/server/types.md b/server/types.md index b7c035b..29cb866 100644 --- a/server/types.md +++ b/server/types.md @@ -3,4 +3,11 @@ | -------- | ---- | ----------- | name | String | The player's name. | role | String | The player's role. This will be one of `"guesser"` or `"writer"`. -| team | Integer | The player's team. This will be one of `1` or `2` \ No newline at end of file +| team | Integer | The player's team. This will be one of `1` or `2` + +## Game: +| Property | Type | Description +| -------- | ---- | ----------- +| game_code | String | The game's unique identifier used for joining the game. +| players | Player[] | The players that are currently in the game. +| state | String | What state the game is currently in. This can be one of `"lobby"`, or `"playing"` \ No newline at end of file