Begin on the docs for the code that resides in it's own folder

This commit is contained in:
Oliver-Akins 2022-01-04 20:32:03 -07:00
parent 642e1b2de6
commit 8156085ef3

30
docs/events.md Normal file
View file

@ -0,0 +1,30 @@
# Events
Every event in this document has two forms, a request and a response, the event
type can be differentiated by the event prefix, `req` is an event going to the
server, and `res` is a response coming from the server to the client. Some events
may only have one of these types, if this is the case, it will be denoted in the
relevant section.
**Important**: Events with the `Broadcasted` event type, must be listened to
even if you don't send any `Request` events of that type. This is because other
clients connected to the server may trigger the server in such a way that the
event response gets sent to multiple clients.
---
## `server.info`
Asks the server for information about it.
### Supported Event Types
| Request | Response | Broadcasted
| ------- | -------- | -----------
| Yes | Yes | No
### Payloads:
Request Payload: `IServerInfoRequest`
Response Payload: `IServerInfoResponse`
---