2025-07-17 09:19:51 +08:00

87 lines
3.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 简体中文
[English](https://git.branulf.top/Branulf/ServerPlayerOnlineTracker/src/branch/master/README_EN.md)
# ServerPlayerOnlineTracker - 服务器玩家在线及状态追踪
一个简单的 Fabric 服务器端 Mod用于追踪玩家在线时长、显示服务器实时状态并提供一个美观的网页界面。
## 主要功能
* **玩家在线时长追踪**
* 记录玩家总在线时长、最近30天和最近7天的在线时长。
* 支持仅追踪白名单玩家(可在配置文件中设置)。
* 数据自动保存,防止服务器崩溃导致数据丢失。
* **服务器状态监控**
* 实时显示服务器内存使用情况(已用/可用/使用率)。
* 实时显示服务器磁盘使用情况(总量/已用/可用/使用率)。
* 实时显示服务器性能指标TPS/MSPT
* 显示服务器运行时间、版本、在线玩家数、最大玩家数、MOTD、处理器核心数。
* **网页界面**
* 提供一个直观、响应式的网页界面,方便查看所有统计数据。
* 支持深色/浅色主题切换。
* 数据自动刷新。
* **游戏内命令**
* `/onlineTime [页码]`:在游戏内查看玩家在线时长排行榜。
* **多语言支持**
* 支持简体中文 (`zh_cn`) 和英文 (`en_us`)。
* 可在配置文件中切换语言。
* **更新检查**
* Mod 启动时自动检查新版本。
## 安装
1. 确保您的 Minecraft 服务器已安装 Fabric Loader (推荐 0.15.0+)。
2. 下载最新版本的 `ServerPlayerOnlineTracker-*.jar` 文件。
3. 将下载的 `.jar` 文件放入服务器的 `mods` 文件夹。
4. 启动服务器。
## 使用方法
### 网页界面
Mod 启动后,会自动在您配置的端口(默认 `60048`)启动一个 Web 服务器。
1. 在浏览器中访问 `http://您的服务器IP:60048` 即可查看所有统计数据。
2. 如果端口被占用或您想更改端口,请修改 `config/playertime-config.json` 文件中的 `webPort` 字段。
### 游戏内命令
* `/onlineTime`:查看第一页玩家在线时长排行榜。
* `/onlineTime <页码>`:查看指定页码的玩家在线时长排行榜。
## 配置文件
首次运行 Mod 后,会在服务器根目录的 `config` 文件夹下生成一个 `playertime-config.json` 文件。您可以编辑此文件来调整 Mod 的行为。
```json
{
"webPort": 60048, // 网页服务器监听的端口,默认 60048
"language": "zh_cn", // 网页和游戏内消息的语言,可选 "zh_cn" 或 "en_us"
"whitelistOnly": true, // 是否只追踪和显示白名单玩家的在线时间,默认 true
"saveIntervalMinutes": 5 // 自动保存玩家数据的时间间隔(分钟),默认 5 分钟,设置为 0 禁用
}
```
## API
[API文档](https://git.branulf.top/Branulf/ServerPlayerOnlineTracker/src/branch/master/README_API.md)
## 兼容性
* **Minecraft 版本:** 1.21.4+
* **Fabric Loader:** 0.16.10+
* **依赖:** Fabric API
## 许可证
本项目基于 [GPL3 许可证](https://www.gnu.org/licenses/gpl-3.0.en.html) 开源。
## 链接
* **源代码:** [https://git.branulf.top/Branulf/ServerPlayerOnlineTracker](https://git.branulf.top/Branulf/ServerPlayerOnlineTracker)
* **主页:** [https://git.branulf.top/Branulf](https://git.branulf.top/Branulf)
## 鸣谢
* **作者:** BRanulf