ServerAPI

插件

· 作者 serenestriker_

ServerAPI 是一个 REST API 插件,在 HTTP 服务器上提供服务器信息,如死亡数、击杀数、玩家余额、宝箱钥匙、TPS 等。它为外部应用程序提供了安全桥梁,使其能够轻松获取实时服务器信息。

0 本站下载 0 关注 更新于 8 个月前

最新 1.0 · 1.21.11 · Bukkit / Paper

一键开服(送7天)

logo

ServerAPI 是一个高性能的 REST API 插件,通过安全且受令牌保护的接口,提供实时的 Minecraft 服务器指标、玩家统计信息以及第三方插件数据。

preview

它通过在单独的线程上运行异步 HTTP 服务器来工作,并使用反射技术安全地获取深层服务器信息,而不会影响游戏性能或 TPS(每秒刻数)。

使用指南

  1. 安装与构建 将 ServerAPI-1.0.jar 放入你的 plugins 文件夹。 启动服务器以生成 config.yml 配置文件。

  2. API 端点与数据说明

状态 (GET /status) 提供服务器的总体概览:

  • online: 服务器在线状态。
  • version: 服务器软件版本。
  • paper_version: 具体实现版本。
  • players: 包含在线人数和最大人数的子对象。
  • tps: 当前每秒刻数(1 分钟平均值)。
  • mspt: 每刻毫秒数(平均值)。
  • uptime: 服务器总运行时间(秒)。
  • worlds: 已加载的世界名称列表。

性能 (GET /performance) 详细的资源与健康指标:

  • tps: 精确的 1 分钟、5 分钟和 15 分钟平均值。
  • mspt: 平均刻时间(高度准确)。
  • lag_warning: 布尔值,如果 TPS 低于 18.0 则标记为 true。

玩家信息 (GET /player/{name}) 针对在线和离线玩家的全面数据:

  • name, uuid, online status: 名称、UUID、在线状态。
  • lastSeen: 可读的时间格式(例如,“2 小时前”)。
  • playtime: 格式化后的总游玩时间(小时)。
  • kills / deaths: 安全统计数据(如果数据尚未加载/追踪,则安全返回 0)。
  • money: 使用 Vault 插件格式化显示的余额。
  • alts: 来自 EssentialsX 的 IP 匹配的小号账号。
  • crates: 特定箱子类型的列表,以及玩家拥有的虚拟钥匙数量。

其他端点

  • /misc/balancetop: 最富有的前 10 名玩家(基于配置缓存)。
  • /misc/statistics: 击杀/死亡总数的全球前 10 名(已缓存)。
  • /misc/warps: 所有可用的 EssentialsX 传送点。
  • /misc/crates: 所有注册的 ExcellentCrates ID。
  • /misc/projectkorra: 按元素分组的所有 bending 能力。

配置 (config.yml)

  • 安全性: 所有请求都需要 Authorization: Bearer YOUR_TOKEN。
  • 开关: 上述每个端点和子端点都可以单独禁用。
  • 缓存: 像 BalTop 和全局统计这类重度查询具有可配置的缓存持续时间(默认 5 分钟),以保护服务器的 TPS。
  • 异步: API 在单独的线程池上运行,确保对 Minecraft 服务器性能零影响。

一张展示该插件用例示例的图片:

use-case

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源