nonebot-plugin-mcserver-status-check 0.1.8

A vanilla-style, beautiful and efficient Minecraft server status query plugin

✨ nonebot-plugin-mcserver-status-check ✨

📖 介绍

• 支持同时查询多个服务器。
• 生成美观的状态卡片图片。
• 显示服务器图标 (Favicon)。
• 解析并渲染 Minecraft 颜色代码 (MOTD)。
• 详细的延迟测试（预热、多次测试取平均值、去极值）。
• 可配置的字体和显示选项。

🎨 效果图

💿 安装

使用 nb-cli 安装

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

nb plugin install nonebot-plugin-mcserver-status-check --upgrade

使用 pypi 源安装

nb plugin install nonebot-plugin-mcserver-status-check --upgrade -i "https://pypi.org/simple"

使用清华源安装

nb plugin install nonebot-plugin-mcserver-status-check --upgrade -i "https://pypi.tuna.tsinghua.edu.cn/simple"

使用包管理器安装

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

uv

uv add nonebot-plugin-mcserver-status-check

安装仓库 master 分支

uv add git+https://github.com/leiuary/nonebot-plugin-mcserver-status-check@master

pdm

pdm add nonebot-plugin-mcserver-status-check

安装仓库 master 分支

pdm add git+https://github.com/leiuary/nonebot-plugin-mcserver-status-check@master

poetry

poetry add nonebot-plugin-mcserver-status-check

安装仓库 master 分支

poetry add git+https://github.com/leiuary/nonebot-plugin-mcserver-status-check@master

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

plugins = ["nonebot_plugin_mcserver_status_check"]

使用 nbr 安装(使用 uv 管理依赖可用)

nbr 是一个基于 uv 的 nb-cli，可以方便地管理 nonebot2

nbr plugin install nonebot-plugin-mcserver-status-check

使用 pypi 源安装

nbr plugin install nonebot-plugin-mcserver-status-check -i "https://pypi.org/simple"

使用清华源安装

nbr plugin install nonebot-plugin-mcserver-status-check -i "https://pypi.tuna.tsinghua.edu.cn/simple"

⚙️ 配置

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

# 服务器列表
MSC_SERVER_LIST='[]'

# 延迟测试间隔(秒)
MSC_LATENCY_INTERVAL=0.1

# 延迟测试预热次数
MSC_LATENCY_WARMUP=2

# 延迟测试次数
MSC_LATENCY_COUNT=3

# 是否去极值
# true: 去掉最大最小，取平均 (默认，次数自动加二)
# false: 不去极值，直接取平均
# "best": 最低延迟优先 (适用于校园网等多运营商宽带聚合环境，此时建议调高测试次数)
MSC_LATENCY_TRIM=true

# 是否在控制台显示详细信息
MSC_SHOW_TIMING_DETAILS=false

# 字体文件
MSC_FONT_PATH="minecraft.ttf"

# 触发指令列表
MSC_COMMAND_TRIGGERS=["查服"]

# 是否在列表模式显示玩家名单
MSC_SHOW_PLAYER_LIST=false

服务器列表配置示例

MSC_SERVER_LIST='[
  {"address": "mc.hypixel.net", "alias": "Hypixel"},
  {"address": "play.example.com"}
]'

🎉 使用

指令列表

• 查服
  • 查询所有配置的服务器状态，生成汇总图片。
• 查服 [IP/别名]
  • 单独查询指定服务器的状态。
• 查服列表
  • 查看当前配置的服务器列表及别名。

💡 特性

• 🎨 原版风格：完美还原 Minecraft 游戏内的服务器列表显示效果。
• ⚡ 高效并发：支持多服务器并行查询，速度飞快。
• 📊 精准延迟：内置预热和去极值算法，提供最真实的延迟数据。
• 📝 颜色支持：完整支持 Minecraft 样式代码 (§) 和 JSON 格式 MOTD。
• 🖼️ 图标显示：自动获取并显示服务器 Favicon。
• 👥 玩家列表：支持显示在线玩家列表（需服务器开启相关功能）。

📝 TODO

• 支持不同群聊存放不同列表。
• 支持基岩版服务器查询.