uxmEssentials REST

插件

· 作者 siracozmen

uxmEssentials 的 HTTP 和 WebSocket API,适用于面板、机器人和脚本。需要主 jar 文件。

0 本站下载 0 关注 更新于 3 周前

最新 0.10.1 · 26.2 · Folia / Paper

一键开服(送7天)

uxmEssentials REST 附加组件

为无法作为插件运行的程序(如 Web 面板、Discord 机器人、商店 Webhook、仪表盘或脚本)提供对 uxmEssentials 的 HTTP 和 WebSocket 访问。

阅读文档 在 GitHub 上查看我们

适用于 Paper 适用于 Purpur

在 Hangar 上获取 基于 Java 25 构建

Paper 26.2  ·  Java 25  ·  支持 Folia  ·  uxmEssentials 伴侣插件  ·  开源 (GPL-3.0)

功能说明

uxmEssentials 发布了一个开发者 API,服务器上的任何插件都可以对其进行编译。此附加组件将该 API 的能力扩展到了网络套接字层面,使得使用任意编程语言编写的程序都能调用它。

  • 读取:余额、家园、传送点、玩家自定义传送点、套装、保险箱、制裁与惩罚记录、在线时长、AFK 及隐身状态、传送请求、世界、投票、邮件和忽略列表。
  • 写入:存款、取款和转账;家园和传送点;套装发放与领取;封禁、静音、踢出、警告和监禁;上帝模式、飞行、游戏模式、速度、治疗与喂食;传送;世界加载与卸载;投票和队伍进度;消息和邮件。
  • 订阅:通过 WebSocket 接收实时事件流,涵盖 uxmEssentials 发布的七十四种全部事件类型,无需轮询即可获取所有信息。

本插件完全基于已公开的 API 构建,不依赖其他内容。每个端点都对应一个插件自身可以调用的表面接口,这一原则确保了两者行为的一致性,防止出现偏差。

令牌管理(在游戏中操作)

/uxmapi token create <label> [scopes]   创建令牌(仅显示一次)
/uxmapi token list                      列出所有令牌(不含密钥)
/uxmapi token revoke <label>            使指定令牌失效
/uxmapi status                          查看监听状态及当前连接者

密钥仅在创建时打印一次并支持一键复制,之后不再显示;服务器端仅保存密钥的哈希值。配置文件中不存在粘贴密钥的位置,因为将密钥放入配置文件会导致其泄露到剪贴板、备份文件或技术支持工单中。

每个令牌可授予三种作用域:read 用于所有 GET 请求,write 用于所有 POST 请求,events 用于事件流。同时支持 Authorization: Bearer 和 HTTP Basic 认证方式。

安装设置

  1. 将 uxmEssentials-rest-0.8.0.jar 放入 plugins/ 目录,与主 uxmEssentials 插件 jar 文件放在一起,然后重启服务器。

  2. 默认情况下不会启动监听。附加组件会生成 plugins/uxmEssentials-rest/config/rest.conf 配置文件,并在日志中提示开关位置,保持静默状态,因为一个因安装而自动开始监听的 jar 包属于事故而非功能特性。

    enabled = false
    
    # 监听地址。默认为回环地址,这也是推荐的位置。
    bind = "127.0.0.1"
    port = 8123
    
    # 每个令牌每分钟允许发起的请求数量。
    requests-per-minute = 120
    
    # 跨所有令牌同时打开的事件流连接最大数量。
    max-subscribers = 8
    
  3. 将 enabled = true,重启服务器,并使用 /uxmapi token create panel 创建一个令牌。

curl -H "Authorization: Bearer uxm_..." \
  http://127.0.0.1:8123/api/v1/players/$UUID/balance
{ "ok": true, "data": { "currency": "coins", "amount": 1250.50 } }

如果服务器理解该操作但拒绝执行,并不会返回 HTTP 错误码,而是返回 ok:false 以及 Java API 返回的相同失败代码,因此消费者可以在 HTTP 层面对同一字符串进行分支判断,与进程内处理保持一致。

系统要求

  • 服务器: 运行 uxmEssentials 0.8.0 的 Paper 26.2。
  • 必须安装主插件:此附加组件无法独立运行。
  • 不支持 TLS:监听器使用纯 HTTP 协议,默认绑定到回环地址。如果需要外部访问,请在其前端部署反向代理。

备注

开源协议 (GPL-3.0)。完整的端点、请求体字段和事件参考文档见:docs.uxplima.com。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源