diff --git a/README.md b/README.md index 573804f..99c20bf 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ messages starting with a slash are sent to chat only if the `--disable-commands` ## docs - [Compiling](docs/compiling.md) -- [Message formats](docs/message_formats.md) +- [User agents](docs/user_agents.md) - [Authenticated mode](docs/auth_mode.md) - [WRAC protocol (v2.0)](docs/wrac.md) - [FAQ](docs/faq.md) diff --git a/docs/message_formats.md b/docs/message_formats.md deleted file mode 100644 index 0f04c8e..0000000 --- a/docs/message_formats.md +++ /dev/null @@ -1,47 +0,0 @@ -# message formats - -## types - -### bRAC - -this client - -```yml -format: "리㹰<{name}> {text}" -regex: "\uB9AC\u3E70<(.*?)> (.*)" -color: "green" -``` - -### CRAB - -[CRAB - client & server for RAC written in java](https://gitea.bedohswe.eu.org/pixtaded/crab) - -```yml -format: "═══<{name}> {text}" -regex: "\u2550\u2550\u2550<(.*?)> (.*)" -color: "light red" -``` - -### Mefedroniy - -[Mefidroniy - client for RAC written in rust](https://github.com/OctoBanon-Main/mefedroniy-client) - -```yml -format: "°ʘ<{name}> {text}" -regex: "\u00B0\u0298<(.*?)> (.*)" -color: "light magenta" -``` - -### clRAC - -official client - -```yml -format: "<{name}> {text}" -regex: "<(.*?)> (.*)" -color: "cyan" -``` - -## developer notes - -in auth-mode, there is must to be `> ` after name (`{name}> {text}`) \ No newline at end of file diff --git a/docs/user_agents.md b/docs/user_agents.md new file mode 100644 index 0000000..1b1f0b2 --- /dev/null +++ b/docs/user_agents.md @@ -0,0 +1,18 @@ +# user agents + +User agents in RAC is the way how to get know from what client the message was sent. It works by just checking the message text throught regex. + +## clients + +Here are listed the most common clients, and their name colors in the chat. + +| Client | Format | Regex | Color | +| :----: | :----: | :----: | :----: | +| [bRAC](https://github.com/MeexReay/bRAC) | 리㹰<{name}> {text} | `\uB9AC\u3E70<(.*?)> (.*)` | green +| [CRAB](https://gitea.bedohswe.eu.org/pixtaded/crab) | ═══<{name}> {text} | `\u2550\u2550\u2550<(.*?)> (.*)` | light red +| [Mefidroniy](https://github.com/OctoBanon-Main/mefedroniy-client) | °ʘ<{name}> {text} | `\u00B0\u0298<(.*?)> (.*)` | light magenta +| clRAC | <{name}> {text} | `<(.*?)> (.*)` | cyan + +## developer notes + +in auth-mode, there is must to be `> ` after name (`{name}> {text}`) \ No newline at end of file