From ad3c3fe867307bab554bf457e2096db98afafaf2 Mon Sep 17 00:00:00 2001 From: Keuin Date: Sat, 5 Feb 2022 22:27:54 +0800 Subject: README: update description. --- README.md | 5 +++++ README_zh_CN.md | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 31eeb1d..1398113 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/README_zh_CN.md b/README_zh_CN.md index e0aaa49..490f9b2 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -9,6 +9,7 @@ # 1. CrossLink: 基于规则路由的 BungeeCord/Velocity 消息互联框架 CrossLink 的目的是连接Minecraft群组服务器和即时通讯软件。 +CrossLink 是 [BungeeCross](https://github.com/hit-mc/BungeeCross) 的重构版本，大量代码被重写以改善软件质量。 CrossLink 将每个子服务器的聊天窗口视为独立的端点，将每个即时通讯软件的群聊也视为独立的端点。 服务器管理员编写配置文件，描述消息将如何在这些端点之间互相转发，从而让玩家无论在哪个子服务器 或者哪个即时通讯软件里，都可以在一起聊天。 @@ -16,6 +17,9 @@ CrossLink 将每个子服务器的聊天窗口视为独立的端点，将每个 这些**基本操作（action）** 组合成为**路由规则（rule）**，有限个路由规则的有序排列形成**路由表**。 CrossLink 按照路由表转发消息，基本操作的组合可实现自由而强大的消息转发，从而 提供高度定制化的 Minecraft 群组服务器消息互联方案。 +目前 CrossLink 仅内置对 Telegram 的支持。如果您需要连接诸如微信、QQ 等即时通讯平台，建议为其编写独立的程序，并通过`psmb`协议连接到 CrossLink。 + + # 2. 运行环境 - Minecraft 反向代理服务器： -- cgit v1.2.3