Описание
# RankBoard
[](https://choosealicense.com/licenses/mit/)
[](https://modrinth.com/project/rankboard)
[](https://www.curseforge.com/minecraft/mc-mods/rankboard)
[](https://www.curseforge.com/minecraft/mc-mods/rankboard)
[](https://github.com/halfkite/rankboard/releases)
**中文** | [English](#english)
## 依赖
| 名称 | 类型 | 链接 | 备注 |
| --- | --- | --- | --- |
| Fabric Loader | Fabric 必须 | [官方](https://fabricmc.net/use/installer/) | 1.21.x 使用 0.15.11+ |
| Fabric API | Fabric 必须 | [官方](https://fabricmc.net/) | 与目标 Minecraft 版本匹配 |
| NeoForge | NeoForge 必须 | [官方](https://neoforged.net/) | 安装对应游戏版本 |
## 版本支持
| 加载器 | 游戏版本 | 状态 | 最新 RankBoard |
| --- | --- | --- | --- |
| Fabric | 1.21–1.21.11 | 维护中 | 1.9.1 |
| Fabric | 26.1、26.1.1、26.1.2 | 维护中 | 1.9.1 |
| Fabric | 26.2 | 维护中 | 1.9.1 |
| NeoForge | 1.21.1、1.21.4、1.21.8、1.21.11 | 维护中 | 1.9.1 |
| NeoForge | 26.1、26.1.1、26.1.2、26.2 | 维护中 | 1.9.1 |
## 文档
- [中文完整文档](docs/rankboard.md)
- [English documentation](docs/rankboard_en.md)
## 下载
- [Modrinth](https://modrinth.com/project/rankboard)
- [CurseForge](https://www.curseforge.com/minecraft/mc-mods/rankboard)
- [GitHub Releases](https://github.com/halfkite/rankboard/releases/latest)
介绍页面的布局参考了 [Carpet-Igny-Addition](https://github.com/liuyuexiaoyu1/Carpet-Igny-Addition)。
---
## 中文
RankBoard 是一个服务端排行榜模组，支持 Fabric 和 NeoForge。玩家不需要客户端模组即可使用原版计分板和网页查看排行榜。
当前版本：`1.9.1` | [完整中文文档](docs/rankboard.md) | [English documentation](docs/rankboard_en.md)
### 功能简介
- 17 种统计榜单，支持 daily / weekly / monthly / yearly / all 五种时间周期
- 游戏内原版侧边栏：个人榜、全服榜、轮播榜，进服自动恢复
- 网页排行榜：日期范围查询、在线筛选、主题配色、多服务器切换
- 离线数据读取、后台缓存更新、IP 请求限流、白名单筛选
### 安装
**Fabric：**
1. 安装对应 Minecraft 版本的 Fabric Loader 和 Fabric API。
2. 将 JAR 放入服务器 `mods/` 目录。
**NeoForge：**
1. 安装对应 Minecraft 版本的 NeoForge。
2. 将 JAR 放入服务器 `mods/` 目录。
启动服务器一次生成 `config/rankboard/` 配置目录，修改配置后重启或使用 `/leaderboard config reload`。
1.21 系列需要 Java 21+；26.x 系列需要 Java 25+。
### 快速上手
```text
/leaderboard 打开可点击的排行榜菜单
/leaderboard mine 查询自己的统计分数
/leaderboard display show all playtime 显示在线榜侧边栏
/leaderboard help 查看帮助
```
更多命令、配置和游戏内操作说明请参阅[完整文档](docs/rankboard.md)。
---
## English
RankBoard is a server-side leaderboard mod supporting Fabric and NeoForge. Players do not need a client-side mod to use the vanilla sidebar or the web dashboard.
Current version: `1.9.1` | [中文文档](docs/rankboard.md) | [English documentation](docs/rankboard_en.md)
### Highlights
- 17 ranking metrics with daily / weekly / monthly / yearly / all periods
- Vanilla sidebar: personal, server-wide, and carousel modes with join restoration
- Web dashboard: date range queries, online filtering, themes, multi-server switcher
- Offline data, background caching, IP rate limiting, whitelist filtering
### Installation
**Fabric:**
1. Install Fabric Loader and Fabric API for the target Minecraft version.
2. Put the JAR in the server `mods/` directory.
**NeoForge:**
1. Install NeoForge for the target Minecraft version.
2. Put the JAR in the server `mods/` directory.
Start the server once to create `config/rankboard/`. Restart after editing configuration, or run `/leaderboard config reload`.
Minecraft 1.21 requires Java 21+. Minecraft 26.x requires Java 25+.
### Quick Start
```text
/leaderboard Open the clickable ranking menu
/leaderboard mine Show your personal scores
/leaderboard display show all playtime Show the playtime sidebar
/leaderboard help Show command help
```
See the [full documentation](docs/rankboard_en.md) for all commands, configuration, and in-game operations.