A vanilla-style, beautiful and efficient Minecraft server status query plugin
Project description
📖 介绍
- 支持同时查询多个服务器。
- 生成美观的状态卡片图片。
- 显示服务器图标 (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=1
# 延迟测试次数
MSC_LATENCY_COUNT=3
# 是否去极值(去掉最大最小)
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", "alias": "示例服"}
]'
🎉 使用
指令列表
- 查服
- 查询所有配置的服务器状态,生成汇总图片。
- 查服 [IP/别名]
- 单独查询指定服务器的状态。
- 查服列表
- 查看当前配置的服务器列表及别名。
🎨 效果图
如果有效果图的话
💡 特性
- 🎨 原版风格:完美还原 Minecraft 游戏内的服务器列表显示效果。
- ⚡ 高效并发:支持多服务器并行查询,速度飞快。
- 📊 精准延迟:内置预热和去极值算法,提供最真实的延迟数据。
- 📝 颜色支持:完整支持 Minecraft 样式代码 (§) 和 JSON 格式 MOTD。
- 🖼️ 图标显示:自动获取并显示服务器 Favicon。
- 👥 玩家列表:支持显示在线玩家列表(需服务器开启相关功能)。
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nonebot_plugin_mcserver_status_check-0.1.3.tar.gz.
File metadata
- Download URL: nonebot_plugin_mcserver_status_check-0.1.3.tar.gz
- Upload date:
- Size: 3.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.13.1 Windows/11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
640b2075e189fded4d6c5030d699943a0e518bd6f1f1d8a56b1a57111c6abce8
|
|
| MD5 |
f23bed9aee76f2a9f698ec7a2fcd1fa3
|
|
| BLAKE2b-256 |
67b71e51a73eabeb7ea01804e7a59d8e7dc9465617d009a358542f238e600676
|
File details
Details for the file nonebot_plugin_mcserver_status_check-0.1.3-py3-none-any.whl.
File metadata
- Download URL: nonebot_plugin_mcserver_status_check-0.1.3-py3-none-any.whl
- Upload date:
- Size: 3.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.13.1 Windows/11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f09aa3099e85328b23cb34904fe4f4ca4815eca96e1d00bb53e13ff9024dc8e0
|
|
| MD5 |
d0daf675932b626e268851d101f58b8d
|
|
| BLAKE2b-256 |
fed5c23e9e1c47582b273d0da0bdcd7578cdd81ef7a0d63998a9d359cb0a3f9a
|