Add a document detailing all the events that the client will send to the server
This commit is contained in:
parent
0edf74ab7f
commit
526b4c5771
1 changed files with 34 additions and 0 deletions
34
server/events.md
Normal file
34
server/events.md
Normal file
|
|
@ -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.
|
||||
|
||||
---
|
||||
Loading…
Add table
Add a link
Reference in a new issue