====== Sock Chat Protocol Documentation ======

Sock Chat is a chatting protocol that operates on a text-mode [[https://developer.mozilla.org/en-US/docs/Web/API/WebSocket|WebSocket]] (([[doi>10.17487/RFC6455]])).
Messages sent between the client and server are a series of concatenated strings delimited by the vertical tab character, represented in most languages by the escape sequence ''%%\t%%'' and defined in ASCII as ''%%0x09%%''.
This wiki documents all behaviour that can be expected from a Sock Chat client and server.

Updated behaviour will be added through extensions called capabilities at a later date.
Not providing any capabilities will have the protocol continue behaving as defined by the original PHP implementation.

===== Sections =====

  * [[sockchat:types|Types]] - Describes all data types that occur in packets.
  * [[sockchat:c2s|Client to Server (C2S) Packets]] - Describes all packets that a client can send to a server.
  * [[sockchat:s2c|Server to Client (S2C) Packets]] - Describes all packets that a server may send to a client.
  * [[sockchat:capabilities|Capabilities]] - Describes all capabilities and what changes in behaviour they cause.
  * [[sockchat:commands|Commands]] - Describes all client commands a server is expected to understand.
  * [[sockchat:notices|Notices]] - Describes all formatting strings for informational and error messages.
  * [[sockchat:bbcodes|BB Codes]] - Describes common BB Code formats.
  * [[sockchat:start|Old Documentation]] - Previous version of the documentation, will remain available until all information has been moved over.

===== Attribution =====

  * Sock Chat was created by [[http://dev.aroltd.com|reemo]].
  * Current version of the protocol is maintained by [[https://flash.moe|flashwave]].
  * [[https://patchii.net/flashii/mami|Mami]] and [[https://patchii.net/flashii/sharp-chat|SharpChat]] for [[https://flashii.net|Flashii]] Chat are currently considered the reference client and server implementations for new developments.
  * What is described as "Core" in this documentation is equivalent to the behaviour of the [[https://patchii.net/sockchat/sockchat|original PHP client and server source]].