README.md

nonebot-plugin-mccheck

✨ Minecraft 服务器查询插件 ✨

简体中文|English

📖 介绍

Minecraft服务器状态查询，支持IPv6

与https://github.com/molanp/zhenxun_check_Minecraft/同步更新

💿 安装

以下提到的方法任选 其一 即可

[推荐]使用 nb-cli 安装

在 Bot 的根目录下打开命令行, 输入以下指令即可安装

nb plugin install nonebot-plugin-mccheck

使用包管理器安装

在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

pip install nonebot-plugin-mccheck
# or
pdm add nonebot-plugin-mccheck
# or
poetry add nonebot-plugin-mccheck
# or
conda install nonebot-plugin-mccheck

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入

    plugin["nonebot_plugin_mccheck"]

📈 已实现的功能

• 支持全平台适配器
• 适配Unicode全字体与字形
• 渲染Motd样式
• 查询服务器昵称
• 查询服务器最大人数,当前人数
• 查询服务器motd
• 返回服务器地址及端口
• 返回服务器在线状态
• 查询服务器延迟
• 更精确的延迟
• 支持UDP服务器
• 错误信息反馈
• 端口自动补全
• 智障能判断IP地址是否正确
• 获取服务器motd的json版本(仅当服务器motd设置为json格式时)
• 不依赖任何外部api
• 支持特殊端口查询(如2,80,443等)
• 查询服务器favicon
• 多语言
• SRV支持
• 完全彩色下划线/删除线

📑 未来的功能

• 获取服务器协议号
• 获取服务器官网[如果存在]
• 敬请期待

🖼️ 效果图

v0.1.22

文本消息

图片消息

HTML消息

互通服(不止支持HTML消息，此处仅展示一种)

⚙️ 配置

在 nonebot2 项目的.env文件中添加下表中的必填配置

配置项	必填	默认值	说明
MCC__LANGUAGE	否	zh-cn	插件渲染图片所使用的语言 可用语言:[zh-cn,zh-tw,en]
MCC__TYPE	否	0	插件发送的消息类型(0为HTML渲染图片, 1为图片, 2为文本)

🎲 消息类型对比

类型	特殊样式	Favicon	完全彩色下划线/删除线	全Unicode字体支持
文本	❌	⭕	❌	⭕
图片	⭕	⭕	⭕	❌
HTML	⭕	⭕	⭕	⭕

🎉 使用

命令	参数	范围	说明
查服/mcheck	[ip]:[端口] 或 [ip]	私聊/群聊	查询服务器状态
设置语言/set_lang	语言名称	私聊/群聊	设置插件渲染图片所使用的语言
当前语言/lang_now	无	私聊/群聊	查看当前插件渲染图片所使用的语言
语言列表/lang_list	无	私聊/群聊	查看插件支持的语言列表