From d740782abe16b5d7e409f9da57a4dc47e1a8742c Mon Sep 17 00:00:00 2001
From: Andy Zhang <37402126+AnzhiZhang@users.noreply.github.com>
Date: Fri, 16 Dec 2022 20:16:11 +0000
Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20add=20readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 readme.md | 146 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 146 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..925980a
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,146 @@
+<!-- markdownlint-disable MD024 -->
+# ChatHub
+
+> [Velocity](https://velocitypowered.com/) 跨服聊天插件
+
+## 演示视频
+
+<https://user-images.githubusercontent.com/37402126/208178900-9c3b4ba1-0c78-4ca1-830d-0b70ef7b3db8.mp4>
+
+## 指令
+
+指令前缀：`/chathub`。
+
+## list
+
+例子：`/chathub list`。
+
+显示所有子服的玩家列表。
+
+## msg
+
+例子：`/chathub msg Steven hi`
+
+向玩家发送私聊消息，即使不在同一个子服。
+
+## 配置文件
+
+### servername
+
+配置各服务器名称，应当与 Velocity 的名称对应，请注意 `kook` 与 `qq` 为特殊名称，并非 MC 服务器。
+
+### minecraft
+
+MC 相关配置。
+
+#### completeTakeoverMode
+
+默认值：`false`
+
+完全接管模式，当开启时，发送消息的玩家所在的服务器也会显示格式化的消息。请注意开启此功能将会导致子服无法接收到聊天消息，但指令仍可以正常使用。当使用 Bukkit 商店插件或 [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) 等需要子服聊天消息的软件时建议关闭。
+
+### minecraft.message
+
+MC 消息的格式化文本。
+
+#### chat
+
+默认值：`§7[{server}§7]§e{name}§r: {message}`
+
+聊天消息。
+
+#### join
+
+默认值：`§8[§a+§8] §7[{server}§7] §e{name}`
+
+玩家加入服务器消息。
+
+#### leave
+
+默认值：`§8[§c-§8] §e{name}`
+
+玩家离开服务器消息。
+
+#### switch
+
+默认值：`§8[§b❖§8] §e{name}§r: §7«{serverFrom}§7» §6➟ §7«{serverTo}§7»`
+
+玩家切换服务器消息。
+
+#### msgSender
+
+默认值：`§7§o你悄悄地对{target}说: {message}`
+
+`msg` 指令发送人显示的消息。
+
+#### msgTarget
+
+默认值：`§7§o{sender}悄悄地对你说: {message}`
+
+`msg` 指令接收人显示的消息。
+
+#### list
+
+默认值：`§8§l» §7[{server}§7] 当前共有§6{count}§7名玩家在线: §e{playerList}`
+
+`list` 指令显示的消息。
+
+### kook
+
+该功能为双向转发，即 MC 内消息会发送到 Kook 对应频道，频道内消息将被转发到 MC 内。在频道内发送 `/list` 即可查看在线玩家列表。
+
+#### enable
+
+默认值：`false`
+
+是否启用 [Kook](https://www.kookapp.cn/) 转发。
+
+#### token
+
+Kook 机器人 token。
+
+#### channelId
+
+目标服务器频道 ID。
+
+### kook.message
+
+Kook 消息的格式化文本。
+
+#### chat
+
+默认值：`[{server}] <{name}>: {message}`
+
+聊天消息。
+
+#### join
+
+默认值：`[+] [{server}] {name}`
+
+玩家加入服务器消息。
+
+#### leave
+
+默认值：`[-] {name}`
+
+玩家离开服务器消息。
+
+#### switch
+
+默认值：`<{name}>: [{serverFrom}] ➟ [{serverTo}]`
+
+玩家切换服务器消息。
+
+#### list
+
+默认值：`- [{server}] 当前共有{count}名玩家在线: {playerList}`
+
+`/list` 指令显示的消息。
+
+### qq
+
+#### enable
+
+默认值：`false`
+
+是否启用 [QQ](https://im.qq.com/index) 转发。