An open API service indexing awesome lists of open source software.

https://github.com/molanp/nonebot_plugin_mccheck

Minecraft服务器状态查询,支持IPv6/Minecraft server status query, IPv6 supported
https://github.com/molanp/nonebot_plugin_mccheck

minecraft-server-info nonebot-plugin

Last synced: 5 months ago
JSON representation

Minecraft服务器状态查询,支持IPv6/Minecraft server status query, IPv6 supported

Awesome Lists containing this project

README

          


NoneBotPluginLogo

# nonebot-plugin-mccheck

_✨ Minecraft 服务器查询插件 ✨_


license


pypi

python
pypi-download-count

简体中文|[English](README_en.md)

## 📖 介绍

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

> 与[https://github.com/molanp/zhenxun_plugin_mccheck/](https://github.com/molanp/zhenxun_plugin_mccheck)同步更新

## 💿 安装

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

[推荐]使用 nb-cli 安装
在 Bot 的根目录下打开命令行, 输入以下指令即可安装

```shell
nb plugin install nonebot-plugin-mccheck
```

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

```shell
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]` 部分追加写入
```toml
plugin["nonebot_plugin_mccheck"]
```

## 📈 已实现的功能

- [x] IPv6支持
- [x] 支持全平台适配器
- [x] 适配Unicode全字体与字形
- [x] 渲染Motd样式
- [x] 查询服务器昵称
- [x] 查询服务器最大人数,当前人数和玩家列表
- [x] 查询服务器motd
- [x] 返回服务器地址及端口
- [x] 返回服务器在线状态
- [x] 查询服务器延迟
- [x] 更精确的延迟
- [x] 支持互通服务器双次查询
- [x] 错误信息反馈
- [x] 端口自动补全
- [x] 智能判断IP地址是否正确
- [x] 不依赖任何外部api
- [x] 支持特殊端口查询(如`2`,`80`,`443`等)
- [x] 查询服务器favicon
- [x] 多语言
- [x] SRV支持
- [x] 完全彩色下划线/删除线
- [x] 获取服务器协议号

## 📑 未来的功能

- [ ] 敬请期待

## 🖼️ 效果图

v0.1.45
![Image_31020983743694.png](https://github.com/user-attachments/assets/2db47c9a-7ba1-4ce7-a31c-b65f6e848308)
![image](https://github.com/user-attachments/assets/d0830fe9-c690-4017-b601-f46a1d7e1894)

### 🎈 特别说明
查询IPv6服务器
```
查服 [2001:db8:85a3::8a2e:370:7334]:25565 <-IPv6服务器地址及端口,端口和冒号可以不带
```

```
查服 2001:db8:85a3::8a2e:370:7334 <-IPv6服务器地址,插件会自动补全端口号
```

```
查服 2001:db8:85a3::8a2e:370:7334:25565 <-IPv6服务器地址及端口
```

```
查服 [2001:db8:85a3::8a2e:370:7334] <-IPv6服务器地址
```

## ⚙️ 配置

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

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

## 🎲 消息类型对比

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

## 🎉 使用

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