diff --git a/README.md b/README.md new file mode 100644 index 0000000..394cc32 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# AkashicQQ Wiki + +> 欢迎来到 AkashicQQ 官方 wiki + +**AkashicQQ，基于 [NoneBot](https://github.com/nonebot/nonebot2) 框架的异步 QQ 机器人，为你的服务器打造 QQ 群和游戏的一体化体验。** + +AkashicQQ 拥有许多的功能，其配置方法也相对复杂，本 Wiki 旨在详细介绍 AkashicQQ 的功能和配置方法，让您轻轻松松部署您的 QQ 机器人。 + +联系我们：[mc@akashic.cc](mailto:mc@akashic.cc) + +> 友情链接：[Akashic Server 服务器](https://mc.akashic.cc) \ No newline at end of file diff --git a/_coverpage.md b/_coverpage.md new file mode 100644 index 0000000..b684dc3 --- /dev/null +++ b/_coverpage.md @@ -0,0 +1,5 @@ +# **AkashicQQ Wiki** + +> *欢迎来到 AkashicQQ 官方 wiki* + +[开始阅读](README) diff --git a/_sidebar.md b/_sidebar.md new file mode 100644 index 0000000..60ade3d --- /dev/null +++ b/_sidebar.md @@ -0,0 +1,5 @@ +* [首页](README) + +* [功能介绍](feature) + +* [安装](install) diff --git a/feature.md b/feature.md new file mode 100644 index 0000000..2d6d947 --- /dev/null +++ b/feature.md @@ -0,0 +1,79 @@ +# 功能介绍 + +## 入群欢迎 + +在新的玩家加入服务器 QQ 群后，机器人会 @玩家 并发送一条入群欢迎消息。您可以在配置文件中指定入群欢迎的内容，如： + ++ 服务器的地址 ++ 客户端的下载方式 ++ 提示玩家加机器人为好友以支持更多功能 ++ 提示玩家将 QQ 号和游戏角色绑定 ++ 提示玩家输入指令查看机器人帮助 + +## 绑定 QQ + +为了支持更多功能，玩家需要将 QQ 号和游戏角色绑定。可以通过 #绑定 ID 这样命令实现 QQ 号和游戏角色的关联。 + +通过配置，还可以在未绑定账号的玩家每次进入服务器时，在游戏中向他们发送消息，提示他们绑定 QQ 号。 + +## 发送邀请码 + +您可以将 AkashicQQ 和 您的 [Blessing Skin Server](https://github.com/bs-community/blessing-skin-server) 对接，实现在 QQ 群中申请皮肤站的邀请码。您可以通过配置文件指定每个玩家的默认申请次数，也可以手动调整他们的申请余量。管理员可以向机器人无限索要邀请码。 + +## 多服务器支持、多服务端支持 + +AkashicQQ 通过作者的另一个程序 [Prism Console](https://github.com/Mythologyli/Prism) 与 Minecraft 服务器通信。您可以将多个服务器同时接入 AkashicQQ，实现跨服聊天等功能。 + +不仅如此，得益于 Prism Console 使用管道与 Minecraft 通信的特点，AkashicQQ 支持原版、Spigot、Paper、Forge、Fabric、Sponge 等多种服务端，而不依赖于插件或模组环境。与插件和模组不同，AkashicQQ 在实现功能的同时几乎不会对您的服务器性能造成任何影响。 + +## 服务器在线人数查询 + +通过类似 #在线人数 的命令，您的玩家可以在 QQ 中查询所有服务器的在线人数。 + +## 服务器事件广播 + +通过配置，你可以将服务器中的如下事件广播至 QQ 群： + ++ 服务器开启 ++ 服务器关闭 ++ 玩家加入服务器 ++ 玩家退出服务器 ++ 玩家聊天 ++ 玩家获得成就 + +在添加多服务器后，以上信息也会在其他服务器中广播。也就是说，您可以借助 AkashicQQ 直接实现跨服聊天等功能，而无需其它插件或模组。 + +## 服务器 <-> QQ 群双向聊天 + +在 QQ 群中发送类似 #服务器 消息 的指令，可将消息发送至所有连接至 AkashicQQ 的 Minecraft 服务器。 + +由于服务器中玩家的聊天消息会自动发送至 QQ 群，您可以借此实现服务器与 QQ 群的双向聊天。 + +另外，由于玩家的 QQ 号已经和游戏角色绑定，服务器中的玩家可以看到消息发送者的游戏 ID 而非群名片。 + +## 向指定服务器发送命令 + +具有权限的 QQ 号可以向特定服务器发送命令。命令将在服务器控制台执行，并可以将结果返回给您。您也可以为特定命令配置别名，并指定哪些人有权执行命令。 + +您可以借此配合其他插件实现以下功能： + ++ 在 QQ 中查看服务器 TPS ++ 在 QQ 中编辑服务器权限设置 ++ 在 QQ 中查看 PAPI 变量 ++ ...... + +## 呼叫管理员 + +通过类似 #呼叫管理员 消息 的命令，您的玩家可以借助 AkashicQQ 向所有管理员发送消息。消息会同时在游戏内和 QQ 中向管理员私发。再也不担心您的玩家找不到管理员啦！ + +## 管理员接收提醒 + +当您的玩家执行了获取邀请码、呼叫管理员等操作后，所有管理员将收到相应提醒。这可以让服务器管理更加便捷。 + +## 掉线提示 + +通过配置，AkashicQQ 可以在玩家下线时向他们的 QQ 私发消息。再也不担心挂机掉线了！ + +## 哔哩哔哩直播提醒 + +通过配置，您可以让 AkashicQQ 在指定直播间开播时向群内发送提醒。 diff --git a/index.html b/index.html new file mode 100644 index 0000000..ea4c86f --- /dev/null +++ b/index.html @@ -0,0 +1,44 @@ + + + + + + AkashicQQ Wiki + + + + + + + + +
+ + + + + + \ No newline at end of file diff --git a/install.md b/install.md new file mode 100644 index 0000000..c356636 --- /dev/null +++ b/install.md @@ -0,0 +1,29 @@ +# 安装 + +在介绍如何安装 AkashicQQ 前，我们对 AkashicQQ 的架构进行一下介绍，这将有助于我们理解 AkashicQQ 的安装过程。 + +## AkashicQQ 架构 + +AkashicQQ 由以下几个模块构成，模块之间通过网络连接： + ++ AkashicQQ 机器人本体（一个 Python 程序） ++ Prism Console（一个 Python 程序） ++ cqhttp(onebot) 协议实现程序，如 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)、[onebot-kotlin](https://github.com/yyuueexxiinngg/onebot-kotlin)、[OneBot-YaYa](https://github.com/Yiwen-Chan/OneBot-YaYa) 等等 + +可能有读者觉得模块太多，但正是这样的实现增强了 AkashicQQ 的可拓展性、可自定义性，提升了 AkashicQQ 的性能。你甚至可以将三个模块安装在三个服务器上，自由地分配服务器性能。 + +Prism Console 与每个 Minecraft 服务器安装在一起。安装了 Prism Console 后，它将接管您的服务器控制台，以实现上报消息、执行命令等功能。 + +AkashicQQ 可以安装在任意位置，只要此位置能与每个 Prism Console 通过网络连接。AkashicQQ 负责异步地接收、处理 Prism Console 上报的消息，并控制 Prism Console 的行为。 + +AkashicQQ 并不能直接与腾讯的服务器通讯，而要借助 cqhttp(onebot) 协议实现程序。AkashicQQ 与 cqhttp(onebot) 协议实现程序交换信息，后者将信息与 QQ 群交换。您的机器人 QQ 号就是在 cqhttp(onebot) 协议实现程序上登录的。同样，cqhttp(onebot) 协议实现程序可以安装在任意位置，只要此位置能与 AkashicQQ 通过网络连接。 + +您当然可以将这三个模块安装在同一台服务器上。这三个模块都可以在 Windows 或 Linux 上运行，您无需担心平台问题。 + +## 安装前的准备 + +## 安装 Prism Console + +## 安装 cqhttp(onebot) 协议实现程序 + +## 安装 AkashicQQ 本体 \ No newline at end of file