npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

koishi-plugin-mc-check

v1.2.3

Published

Koishi Minecraft 服务插件,支持服务器状态查询、正版皮肤预览、版本更新推送与精美卡片生成

Readme

koishi-plugin-mc-check

项目介绍 (Project Introduction)

中文

这是一个为 Koishi 机器人框架开发的 Minecraft 综合服务插件,使用免费公共 API,支持服务器状态查询、正版皮肤预览、版本更新推送及精美卡片生成。核心特性:

  • 服务器状态查询:使用 api.mcsrvstat.us 获取在线状态、版本、玩家列表、MOTD、软件信息,并通过本地 TCP Ping 测量延迟
  • 正版皮肤预览:输入正版玩家名即可获取全身皮肤(通过 Mojang 官方 API)
  • 版本更新推送:插件启动即缓存最新的正式版/快照版信息,手动或自动检查更新(通过 Mojang 官方 API)
  • 更新推送可覆盖全部群聊与私聊好友;群主/管理员或私聊用户可自行开启或关闭,默认全部不接收
  • 精美状态卡片(需 Puppeteer):暗色主题卡片,展示图标、在线率、MOTD、延迟等
  • 所有提示文本均可在配置页面自定义
  • 内置 Debug 模式,可详细记录 API 请求/响应及操作日志

English

A comprehensive Minecraft plugin for the Koishi bot framework, using free public APIs to query server status, preview vanilla skins, push version updates, and generate beautiful status cards. Key features:

  • Server status query: uses api.mcsrvstat.us for online status, version, player list, MOTD, software info, and local TCP ping for latency
  • Vanilla skin preview: Full-body skin from a username (via Mojang official API)
  • Version update push: caches latest release/snapshot on startup, manual or scheduled checks (via Mojang official API)
  • Update push can cover all groups and private friends; group managers or private users can opt in or out, with all recipients disabled by default
  • Beautiful Status Cards (requires Puppeteer): dark-themed card with icon, player rate, MOTD, ping
  • All reply texts customizable via config
  • Debug mode for detailed API interaction logs

项目仓库 (Repository)

  • GitHub: https://github.com/Minecraft-1314/koishi-plugin-mc-check
  • Issues: https://github.com/Minecraft-1314/koishi-plugin-mc-check/issues

核心指令 (Core Commands)

| 指令 (Command) | 说明 (Description) | 示例 (Example) | |----------------|--------------------|----------------| | mc-check [地址] | 查询服务器状态,不填地址则查询全局服务器列表 | mc-check mc.hypixel.net | | mc-skin <玩家名> | 查看正版玩家的 3D 全身皮肤 | mc-skin Notch | | mc-update | 检查 Minecraft 最新正式版 / 快照版更新 | mc-update | | 接收更新推送 | 私聊开启个人推送;群聊由群主或群管理员开启本群推送 | 接收更新推送 | | 关闭更新推送 | 私聊关闭个人推送;群聊由群主或群管理员关闭本群推送 | 关闭更新推送 | | 更新推送状态 | 查看当前私聊或群聊的推送接收状态 | 更新推送状态 |

配置项说明 (Configuration)

| 配置项 | 类型 | 默认值 | 说明 | |--------|------|--------|------| | debug | boolean | false | 是否开启调试日志(详细输出所有请求/响应) | | globalServers | string[] | [] | 全局默认服务器地址列表 | | globalServerType | 'java'|'bedrock' | 'java' | 全局默认服务器类型 | | requestTimeout | number | 5000 | API 请求超时(毫秒) | | enableAutoUpdatePush | boolean | false | 开启版本更新自动推送 | | autoUpdateTime | string | "09:00" | 版本更新推送时间(HH:mm) | | 更新推送接收偏好 | boolean | false | 群聊和私聊默认均不接收,可分别通过指令开启 | | enableBedrockFallback | boolean | true | Java 服务器离线时自动尝试 Bedrock 查询 | | enableCardImage | boolean | false | 查询单个服务器时生成精美卡片(需 Puppeteer) | | messages.* | string | 见下方 | 所有回复文本均可自定义 |

自定义消息 (Messages)

| 消息键 | 默认值 | 说明 | |--------|--------|------| | mcCheckNoGlobal | 未配置全局服务器 | 无全局服务器提示 | | mcCheckTimeout | 查询超时 | 查询超时提示 | | mcUpdateNoUpdate | 当前已是最新版本,暂无更新。 | 无更新提示 | | mcUpdateRelease | 📦 Minecraft 正式版更新 | 正式版更新标题 | | mcUpdateSnapshot | 📦 Minecraft 快照版更新 | 快照版更新标题 | | mcUpdateError | 获取版本信息失败 | 版本检查失败提示 | | skinNotFound | 未找到该玩家 | 皮肤未找到提示 | | skinTitle | {0} 的皮肤 | 皮肤标题 | | mcCheckInvalidType | 无效的服务器类型,仅支持 java 或 bedrock | 无效服务器类型提示 | | databaseRequired | 本功能需要安装数据库插件(如 database-sqlite)。 | 缺少数据库提示 | | puppeteerRequired | 需要安装并启用 puppeteer 服务才能使用此功能。 | 缺少 Puppeteer 提示 |

依赖 (Dependencies)

  • Koishi 数据库插件(可选):安装后可存储版本缓存并启用推送偏好;未安装时服务器查询、皮肤和版本查看仍可使用,推送设置会返回数据库缺失提示。
  • Puppeteer 服务(可选):若需使用状态卡片图片生成,请安装 koishi-plugin-puppeteer;未安装时插件会自动降级为文本输出。

使用的 API (APIs Used)

所有 API 均为免费公共接口,无需注册或密钥:

| 功能 | API | 说明 | |------|-----|------| | 服务器状态 | api.mcsrvstat.us | Java/Bedrock 双协议,返回在线状态、版本、玩家列表、MOTD 等 | | 延迟测试 | 本地 TCP Ping | 直接连接服务器端口获取真实延迟(毫秒) | | 玩家 UUID | api.mojang.com | 正版玩家名 → UUID | | 皮肤渲染 | visage.surgeplay.com | 正版 3D 全身皮肤渲染 | | 版本清单 | piston-meta.mojang.com | Mojang 官方版本信息(release + snapshot) |

项目贡献者 (Contributors)

| 贡献者 (Contributor) | 贡献内容 (Contribution) | |----------------------|-------------------------| | Minecraft-1314 | 插件完整开发 | | koishi-shangxue-apps | UI 背景图灵感与卡片排版风格参考 | | api.mcsrvstat.us | 免费 Minecraft 服务器状态查询 API | | Mojang (api.mojang.com) | 玩家名 → UUID 查询 | | visage.surgeplay.com | 皮肤 3D 渲染服务 | | piston-meta.mojang.com | Minecraft 官方版本清单 API |

(欢迎通过 Issues 或 PR 加入贡献者列表)

许可协议 (License)

本项目采用 MIT 许可证,详情参见 LICENSE 文件。

This project is licensed under the MIT License, see the LICENSE file for details.

支持我们 (Support Us)

如果这个项目对您有帮助,欢迎点亮右上角的 Star ⭐ 支持我们,这将是对所有贡献者最大的鼓励!

If this project is helpful to you, please feel free to star it in the upper right corner ⭐ to support us, which will be the greatest encouragement to all contributors!