tslocum/bgammon
tslocum/bgammon
2
0
Fork 0
Code Issues 11 Pull requests Projects Releases Wiki Activity

Update PROTOCOL

Browse source
This commit is contained in:
Trevor Slocum 2023-11-14 17:51:36 -08:00
parent a1b1b0d30f
commit ce3a930372
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
PROTOCOL.md
View file

@ -1,10 +1,10 @@
# Specification of bgammon.org protocol
Connect to `bgammon.org:1337` via TCP.
Connect via `bgammon.org:1337` (TCP) or `wss://ws.bgammon.org` (WebSocket).
All commands and events are separated by newlines.
Replace spaces with underscores when sending a password to the server.
When sending a password to the server, replace spaces with underscores.
When connected via TCP, commands and events are separated by newlines.
## User commands
@ -108,7 +108,7 @@ This document lists events in human-readable format.
### Events
- `hello <message:line>`
- Initial welcome message sent by the server. It provides instructions on how to log in.
- Initial welcome message sent only to clients connected via TCP. It provides instructions on how to log in.
- This message does not normally need to be displayed when using a graphical client.
- `welcome <name:text> there are <clients:integer> clients playing <games:integer> matches.`
@ -155,4 +155,4 @@ provide clients with the initial match state.
- `ping <message:text>`
- Sent to clients to prevent their connection from timing out.
- Whether the client replies with a `pong` command, or any other command,
clients must write some data to the server at least once every 40 seconds.
clients must write some data to the server at least once every 40 seconds.