Oliver/Phantom-Ink-Online
0
0
Fork 0
Code Issues Activity

Move event and type docs into their own files.

Browse source
This commit is contained in:
Oliver-Akins 2020-12-19 18:01:36 -07:00
parent ce7e35cd53
commit 2ca4eef0a6
19 changed files with 213 additions and 261 deletions
Download patch file Download diff file Expand all files Collapse all files

15
server/docs/events/CreateGame.md Normal file
View file

@ -0,0 +1,15 @@
# `CreateGame`:
## Description:
Triggered when a user is creating a game.
## Request Payload:
| Property | Type | Description
| -------- | ---- | -----------
| name | String | The name of the person starting the game
## Response Payload: (`GameCreated`)
| Property | Type | Description
| -------- | ---- | -----------
| id | String | The user's game ID, this should be stored to permit users to re-join the game if they get disconnected.
| game_code | String | The game's code that other players can use to connect to the game.