基于mirai的Minecraft服务器信息查询插件

关于Linux运行环境
如果你正在使用Linux而不是Windows来运行Mirai,请确保系统中安装了中文字体，否则图片可能不会被正常渲染。

1. 在这里下载最新的插件文件。

使用.mirai.jar还是.mirai2.jar：
mirai-console自2.11.0版本起支持了新的插件加载方式，如果您正在使用高版本mirai-console，则可以使用.mirai2.jar以避免可能的插件间依赖冲突；.mirai.jar为兼容插件格式，大多数版本的mirai-console均能使用。

2. 将插件文件放入mirai-console运行生成的plugins文件夹中。
3. 如果您还未安装chat-command插件(添加聊天环境中使用命令的功能)，你可以从下面选择一种方法安装此插件：

1. 如果您正在使用Mirai Console Loader来启动mirai-console，您可以运行以下命令来安装chat-command插件：
   ./mcl --update-package net.mamoe:chat-command --channel stable --type plugin
2. 如果您没有使用Mirai Console Loader，您可以在这里下载最新的chat-command插件文件，并将其一同放入mirai-console运行生成的plugins文件夹中。

4. 启动mirai-console之后，在后台命令行输入以下命令授予相关用户使用此插件命令的权限：

• 如果您希望所有群的群员都可以使用此插件，请输入：
  /perm grant m* org.zrnq.mcmotd:command.mcp (仅可使用mcp指令)
  /perm grant m* org.zrnq.mcmotd:* (可使用全部指令)
• 如果您希望只授予某一个群的群员使用此插件的权限，请输入：
  /perm grant m<QQ群号>.* org.zrnq.mcmotd:command.mcp (仅可使用mcp指令)
  /perm grant m<QQ群号>.* org.zrnq.mcmotd:* (可使用全部指令)
• 如果您希望只授予某一个群的特定群员使用此插件的权限，请输入：
  /perm grant m<QQ群号>.<群员QQ号> org.zrnq.mcmotd:command.mcp (仅可使用mcp指令)
  /perm grant m<QQ群号>.<群员QQ号> org.zrnq.mcmotd:* (可使用全部指令)
• 如果你希望了解更多高级权限设置方法，请参阅mirai-console的权限文档

5. 安装完成。

有关权限部分的说明，参见mirai-console的权限文档
根权限： org.zrnq.mcmotd:*

• 获取MC服务器信息： org.zrnq.mcmotd:command.mcp
  • 仅允许获取本群绑定的服务器信息： org.zrnq.mcmotd:command.mcp.strict
• 绑定服务器到群聊： org.zrnq.mcmotd:command.mcadd
• 删除群聊绑定的服务器： org.zrnq.mcmotd:command.mcdel
• 启动/停止服务器的在线人数记录功能： org.zrnq.mcmotd:command.mcrec
• 获取http API访问计数： org.zrnq.mcmotd:command.mcapi
• 重载插件配置： org.zrnq.mcmotd:command.mcreload

/mcp (服务器地址/服务器名称) : 查询指定地址或绑定到指定名称上的服务器信息，当本群仅绑定了一个服务器时可省略参数。

其中，服务器地址可以仅有域名，如mc.example.com，也可以带有端口号，如mc.example.com:12345。

若服务器的玩家列表信息需要通过Query协议获取，则需要同时指定服务器连接端口和Query端口，如mc.example.com:12345:23456。

/mcadd <服务器名称> <服务器地址> : 将指定地址的服务器绑定到指定名称上。各个群聊绑定的服务器相互独立。

/mcdel <服务器名称> : 删除指定名称的服务器

/mcrec <服务器地址> (true/false) : 启动/停止对于指定服务器的在线人数记录，仅有启用了在线人数记录的服务器才会在查询结果图片中附加历史在线人数信息

/mcapi : 获取http API访问计数信息(需要启用http API访问计数功能)

/mcreload : 重载插件配置

插件的配置文件位于/config/org.zrnq.mcmotd/mcmotd.yml

要开启插件的HTTP API功能，需要将配置文件中的httpServerPort设置为非零的可用端口

• 仅启用HTTP API查询指定服务器

配置httpServerMapping为您希望允许查询的服务器列表。
示例配置：

httpServerPort: 8092
httpServerAllowAnyAddress: false
httpServerMapping:   
  hypixel: hypixel.net  
  earthmc: org.earthmc.net  

以上述配置启动McMotd后，访问http://localhost:8092/info/hypixel 将会返回与/mcp hypixel.net相同的图片结果。访问配置文件中未定义的服务器名（如http://localhost:8092/info/foo ）将不会返回有效的结果

• 启用HTTP API查询任意服务器

配置httpServerAllowAnyAddress为true。
示例配置：

httpServerPort: 8092
httpServerAllowAnyAddress: true
httpServerMapping: {}

以上述配置启动McMotd后，访问http://localhost:8092/info/hypixel.net 将会返回与/mcp hypixel.net相同的图片结果

访问以下接口需要配置httpServerEnableDeveloperApi为true

• /raw/{server}获取json格式服务器信息 成功示例

{
  "online":true,
  "favicon":"data:image/png;base64,...", // 服务器图标
  "latency":258, // 服务器ping延迟
  "motd":"{\"text\":\"A Minecraft Server\"}", // 服务器MOTD，可能为纯文本字符串或Text Component格式的JSON字符串
  "players": {
    "list":[], // (可空)玩家列表
    "max":20, // (可空)最大玩家数量
    "online":2 // (可空)当前在线玩家数量
  },
  "version":"1.20.1" // 服务器版本
}

失败示例

{
  "online":false,
  "message":"指定的服务器地址无效:foo" // 错误原因
}

• /icon/{server}获取服务器图标

若服务器无法连接或没有图标，本接口会返回64*64的黑色图片

McMotd支持脱离mirai-console独立运行，可以用于测试或对接其他框架。如需要独立运行McMotd，请下载release 中后缀为.mirai.jar的插件版本（其中包含独立运行所需的完整依赖项），并根据需求选择相应的启动命令（见下方）。 独立运行时，会在当前目录下生成配置文件mcmotd.yml和历史人数记录数据文件mcmotd_data.yml。

• 仅提供HTTP API访问功能

java -cp mcmotd-x.x.x.mirai.jar org.zrnq.mcmotd.StandaloneMainKt

• 仅提供图形化界面访问（用于测试，不启用历史人数记录功能）

java -cp mcmotd-x.x.x.mirai.jar org.zrnq.mcmotd.GUIMainKt

A: 请检查是否安装了chat-command插件，如果没有安装请看这里

A: 如果您正在使用Linux运行mirai，请检查是否安装了中文字体

A: 如果您正在使用Mirai Console Loader，请在/config/Console/PluginDependencies.yml中添加

  - 'https://repo.maven.apache.org/maven2/'

A: 插件自1.1.17版本起，默认启用了Http API的访问冷却时间限制，您可以通过修改配置文件来调整冷却时间长度