Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 913 Bytes

File metadata and controls

75 lines (51 loc) · 913 Bytes

server protocol

channels

channels$

Returns

On success:

channels$
n: <number of channels>
name: <channel name>
id: <channel id>
<...>

whoami

whoami$

Returns

On success:

whoami$
name: <name>
id: <id>

Where <name> is the name you connected with and <id> is your assigned ID.

On failure:

whoami$
error: <reason>

Where <reason> is the reason the request failed.

connect

conn$ <name>

Where <name> is replaced with the user name you would like to use and cannot contain any spaces. It may be blank to then be assigned a name by the server.

Returns

On success:

conn$
name: <name>
id: <id>

Where <name> is the name you ended up with, and <id> is a unique identifier for your connection.

On failure:

conn$
error: <reason>

Where <reason> is the reason you failed to connect.