Velocity Web API

插件

· 作者 skrrtn

一个为 Velocity 代理服务器暴露 Web API 端点的插件。轻松显示玩家和服务器信息。

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

最新 1.4.0 · 1.21.10 · Velocity

一键开服(送7天)

Velocity Web API

Screenshot

适用于 Velocity 代理的轻量级 HTTP API。提供玩家列表、各服务器人数统计、玩家详细信息等功能。非常适合用于网站、机器人或其他监控应用程序。这是我为自己用途开发的,但也许也能帮到其他人。

快速安装

  • 将编译好的插件 JAR 文件放入 Velocity 的 plugins/ 文件夹中。
  • 启动(或重启)你的代理;插件将在插件数据目录中创建其数据文件夹和 config.cfg(如果不存在)。

配置

  • 插件在首次运行时会在其数据文件夹中创建一个 config.cfg。可用的键值如下:
    • port : HTTP 服务器监听的端口(默认 25576)。
    • bindAddress : 绑定 HTTP 服务器的接口/地址(默认 0.0.0.0 以监听所有 IPv4 接口;设置为 127.0.0.1 仅限本地访问)。
    • checkUpdates : 启用自动 Hangar 更新检查(默认 true)。
    • snapshotUpdates : 在检查中包含快照/不稳定版本的更新(默认 false)。
    • debugEnabled : 当为 true 时,在代理控制台中显示调试消息 (logger.debug)(默认 false)。
    • allowedOrigins : 允许访问 HTTP API 的 CORS 来源(逗号分隔,或使用 * 表示全部)(默认 *)。

测试环境

  • Velocity 3.x(期望运行类路径中存在 velocity-api)

端点

除非另有说明,所有 JSON 端点均返回 Content-Type: application/json; charset=utf-8。

  • /

    • 提供嵌入的 index.html(浏览器友好)。
    • 示例 URL: http://localhost:25576/
  • /playerlist

    • 用途:列出已连接的玩家及其基本元数据和总人数。
    • 示例 URL: http://localhost:25576/playerlist
    • 示例响应:
    {
    	"count": 2,
    	"players": 
    	[
    		{"username":"Alice","uuid":"...","currentServer":"lobby"},
    		{"username":"Bob","uuid":"...","currentServer":"minigames"}
    	]
    }
    
  • /count

    • 用途:返回已连接玩家的总数。
    • 示例 URL: http://localhost:25576/count
    • 示例响应:
    { 
    	"count": 42 
    }
    
  • /player/<username> 或 /player?username=<name>

    • 用途:获取已连接玩家的详细信息(精确大小写匹配查找)。
    • 示例 URLs:
      • http://localhost:25576/player/Notch
      • http://localhost:25576/player?username=Notch
    • 注意:如果缺少用户名则返回 400;如果玩家未连接则返回 404。
    • 示例响应:
    {
    	"username":"Notch",
    	"uuid":"...",
    	"currentServer":"lobby",
    	"ping":42,
    	"sessionDurationSeconds":360
    }
    
  • /servers

    • 用途:返回服务器名称到玩家数量的映射。
    • 示例 URL: http://localhost:25576/servers
    • 示例响应:
    { 
    	"lobby": 5, 
    	"minigames": 12 
    }
    
  • /health

    • 用途:用于监控的轻量级健康检查。
    • 示例 URL: http://localhost:25576/health
    • 示例响应:
    { 
    	"status": "ok" 
    }
    

命令

  • /vwapi reload : 从插件数据目录重新加载 config.cfg,如果 port 或 bindAddress 发生更改,则重启 HTTP 服务器。
  • /vwapi version : 打印插件版本(来自插件元数据)。
  • /vwapi debug [on|off] : 在运行时切换或显式设置调试日志记录。启用后,插件会将详细的调试消息和 HTTP 访问行打印到控制台。
  • /vwapi status : 显示当前 HTTP 服务器状态(运行中/未运行)、绑定的主机和端口,以及一个你可以访问的示例 URL(当绑定到所有接口时回退到 localhost)。
  • /vwapi help : 打印简短的帮助信息,列出可用的 /vwapi 子命令及使用示例。

权限

  • vwapi.admin : 使用 /vwapi 命令所需。

注意事项与行为

  • 玩家查找是精确大小写匹配的,且仅返回已连接的玩家。
  • HTTP 服务器绑定到 bindAddress;默认为 0.0.0.0(所有接口)。如需仅限本地访问或指定 IP,请更改为 127.0.0.1。
  • 当你更改 bindAddress 或 port 并运行 /vwapi reload 时,插件将自动重启 HTTP 服务器以应用新的绑定/端口(不再需要为了这些更改而完全重启代理)。

故障排除

  • 如果 HTTP 服务器未能启动,请检查代理日志中关于端口绑定或资源问题的错误。
  • 确保 velocity-api 在运行时可用,并且插件已放置在正确的 plugins/ 文件夹中。

许可与支持

  • 根据 MIT License 授权。
  • 如果你需要任何帮助或支持,请在 我们的 Discord 上联系我。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源