Arisu的REST API +

Arisu 的 REST API + 死亡统计（为什么不呢）

这是一个 Hytale 服务器模组，通过 HTTP 暴露一个 REST API，让您可以从外部工具、仪表板或脚本管理玩家、运行服务器命令以及监控服务器。

---

特性

• 健康检查与状态 – 监控 API 状态和服务器信息
• 死亡追踪 – 通过 /api/deaths、/api/deaths/summary、/api/deaths/recent 内置死亡计数器
• 玩家管理 – 列出在线/已保存的玩家，给予物品，踢出，封禁/解封
• 模组发现 – 通过 /api/mods 和 /api/mods/configs 列出已安装的模组和配置
• 广播与命令 – 通过 HTTP 发送消息和执行服务器命令

---

快速说明

1. 请通过 config.json 中的 apiKey 生成并设置一个 API 密钥。
2. 如何测试：http://localhost:8223/api/health。

除 /api/health 外的所有端点都需要请求头：X-API-Key: <your-api-key>。

---

背景信息

我创建这个模组是因为我和朋友们在托管服务器游玩时，希望有一个地方能集中展示常规信息和实用工具。它最初只是一个副项目，但我在自己的看板和其他模组中大量使用了它，因此我决定将它发布在这里，也许它适合某些人。

我相信通过我构建的一些东西，能更好地展示它的潜力：

通过 API 拉取到我网站上的服务器模组列表：

包含玩家、世界和模组信息的仪表板：

---

主要端点

方法	端点	描述
GET	/api/health	检查 API 状态（无需认证）
GET	/api/server/status	服务器信息
GET	/api/deaths	死亡计数器：摘要、近期死亡、总数（内置追踪）
GET	/api/deaths/summary	每个玩家的死亡计数（按死亡次数排序）
GET	/api/deaths/recent	近期死亡（可选参数 ?limit=50）
GET	/api/mods	列出已安装的模组（mods 文件夹中的 JAR 和 ZIP 文件）
GET	/api/mods/configs	列出模组配置文件夹、配置文件，以及当可从清单解析时列出主类（mods/<folder>/manifest.json 或 mods/<folder>.jar）
GET	/api/universe/players	为看板应用列出 Server/universe/players/*.json 中已保存的玩家（ID, 名称）
GET	/api/universe/players/{id}	根据 ID（不带 .json 的文件名）获取完整玩家 JSON 数据
GET	/api/players	列出在线玩家
GET	/api/players/{name}	获取指定玩家信息
POST	/api/players/{name}/give	给予玩家物品
POST	/api/players/{name}/kick	踢出玩家
POST	/api/players/{name}/ban	封禁玩家
POST	/api/players/{name}/unban	解封玩家
POST	/api/broadcast	向所有玩家发送消息
POST	/api/command	执行服务器命令

---

配置

编辑 mods/ArisuRESTAPI/config.json：

选项	默认值	描述
port	8223	HTTP 端口
apiKey	changeme	认证所需
bindAddress	0.0.0.0	绑定地址（0.0.0.0 表示所有网络接口）

---

如果您愿意，可以通过 Web 使用这些命令以多种方式操控您的服务器。根据需要为您的服务器使用和修改！