Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PROTOCOL.md WRT recent user status protocol changes #5638

Merged
merged 1 commit into from
Jul 21, 2019
Merged

Update PROTOCOL.md WRT recent user status protocol changes #5638

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions PROTOCOL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,21 +150,20 @@ represented by a space), and the rest of the string being their username.

> Changes the HTML display of the `|uhtml|` message named (NAME).

`|join|USER@STATUS` or `|j|USER@STATUS`
`|join|USER`, |j|USER`, or `|J|USER`

> `USER` joined the room. Optionally, `USER` can end in `@` followed by a user status message.
> A `STATUS` starting in `!` indicates the user is away.
> `USER` joined the room. Optionally, `USER` may be appended with `@!` to
> indicate that the user is away or busy.

`|leave|USER@STATUS` or `|l|USER@STATUS`
`|leave|USER`, `|l|USER`, or `|L|USER`

> `USER` left the room. Optionally, `USER` can end in `@` followed by a user status message.
> A `STATUS` starting in `!` indicates the user is away.
> `USER` left the room.

`|name|USER@STATUS|OLDID` or `|n|USER@STATUS|OLDID`
`|name|USER|OLDID`, `|n|USER|OLDID`, or `|N|USER|OLDID`

> A user changed name to `USER`, and their previous userid was `OLDID`.
> Optionally, `USER` can end in `@` followed by a user status message.
> A `STATUS` starting in `!` indicates the user is away.
> Optionally, `USER` may be appended with `@!` to indicate that the user is
> away or busy.

`|chat|USER|MESSAGE` or `|c|USER|MESSAGE`

Expand Down Expand Up @@ -232,13 +231,13 @@ represented by a space), and the rest of the string being their username.
> Finish logging in (or renaming) by sending: `/trn USERNAME,0,ASSERTION`
> where `USERNAME` is your desired username and `ASSERTION` is `data.assertion`.

`|updateuser|USER@STATUS|NAMED|AVATAR|SETTINGS`
`|updateuser|USER|NAMED|AVATAR|SETTINGS`

> Your name, avatar or settings were successfully changed. Your rank and username
> are now `USER`. Optionally, the username can end in `@` followed by a user status message.
> A `STATUS` starting in `!` indicates the user is away. `NAMED` will be `0` if you are a guest or `1` otherwise. Your
> avatar is now `AVATAR`. `SETTINGS` is a JSON object representing the current
> state of various user settings.
> Your name, avatar or settings were successfully changed. Your rank and
> username are now `USER`. Optionally, `USER` may be appended with `@!` to
> indicate that you are away or busy.`NAMED` will be `0` if you are a guest
> or `1` otherwise. Your avatar is now `AVATAR`. `SETTINGS` is a JSON object
> representing the current state of various user settings.

`|formats|FORMATSLIST`

Expand Down