diff options
| author | Keuin <[email protected]> | 2022-02-05 22:27:54 +0800 |
|---|---|---|
| committer | Keuin <[email protected]> | 2022-02-05 22:27:54 +0800 |
| commit | ad3c3fe867307bab554bf457e2096db98afafaf2 (patch) | |
| tree | c23729a3e9331d4dcbc8c1fd02643487109dac18 /README.md | |
| parent | d9eab89c251ae8b2515b4d931901382651277d1f (diff) | |
README: update description.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 5 |
1 files changed, 5 insertions, 0 deletions
@@ -9,6 +9,8 @@ # 1. CrossLink: rule-based intercommunicating framework for BungeeCord and Velocity CrossLink aims at bridging Minecraft chats and instant messaging platforms. +CrossLink is a refactor of legacy [BungeeCross](https://github.com/hit-mc/BungeeCross). +Heavy rewrite has been made to improve software quality. CrossLink treat every chat area in sub-servers of a Minecraft server group as separate *endpoints*. Different instant messaging software are different endpoints, too. Server operator create configuration files, which describes how the @@ -22,6 +24,9 @@ and `forward` into **rules**. Finite rules line up a routing table. CrossLink fo the routing table. The combination of **actions** is versatile to help build a highly configurable message forwarding system among Minecraft grouped servers and instant messaging platforms. +Currently, only Telegram is supported. If you wish to link to other instant messaging platforms, +implementing that protocol in a *standalone* program is encouraged, which could be linked to CrossLink via `psmb` protocol. + # 2. Environment Requirement |