Companion API
We also provide some (at the moment limited) API for users using social-companion:
Checking if a user is using social-companion
Protocol
We use custom payloads for the communication protocol. Custom payloads are also known as plugin messages in Bukkit and its forks. This section discloses those custom payloads.
| Client-server | Parameters | Description | |
|---|---|---|---|
social:open |
S2C | Channel name, alias, icon & description | Opens a new channel tab |
social:close |
S2C | Channel name | Closes an existing channel tab |
social:closeall |
S2C | Reason (can be empty) | Closes all channel tabs |
social:mention |
S2C | Channel name, sender name, sender UUID | Sends a mention notification |
social:switch |
Both | Channel name | Switches the current main channel |
social:preview |
Both | C2S -> Plain text, S2C -> Formatted text | Sends/requests a chat preview |
social:bonjour |
C2S | Empty string | Enables companion features server-side |
social:refresh |
C2S | Reason (can be empty) | Requests the server to refresh channels |