# HikariScoreBoard ![License: All Rights Reserved](https://img.shields.io/badge/license-All%20Rights%20Reserved-red.svg) [![Modrinth](https://img.shields.io/modrinth/dt/hikariscoreboard?label=Modrinth%20Downloads)](https://modrinth.com/mod/hikariscoreboard)

HikariScoreBoard is a **server-side-only Minecraft mod for Fabric servers** that displays player statistics as sidebar rankings. Originally built for the [光鯖 (Hikari Server)](https://hikariserver.com) community. - **Install target**: the Fabric server's `mods/` folder, and nowhere else. Do not put this jar in a client. - **Nothing is required on the client.** Fabric Loader and Fabric API are needed by the *server*. Players connect with whatever they already have — including a completely unmodified vanilla client. ## What each player sees The mod decides per player, from the plugin channels that player's client has registered. All three cases can be on the same server at the same time. | The player's client | What they get | |---|---| | **Vanilla — no mods at all** | The ranking in the ordinary vanilla sidebar. Only vanilla scoreboard packets are used (objective create / display / update, plus one score line per row). No custom packet is ever sent to this player. This is the default and it is fully supported. | | **[Hikari-Tweaks](https://modrinth.com/mod/hikari-tweaks)** | A custom HUD instead of the sidebar — configurable position, scale, colors and pagination — fed over the `hikariscoreboard:ranking_data` channel. The vanilla sidebar is not sent to this player. | | **Hikari-Tweaks with the delta protocol** | The same HUD, fed over the newer `hikariscoreboard:ranking_v2` channel, which sends only the rows that actually changed instead of the whole list. | The `/hikari` chest menu and every `/hikari` subcommand work on a vanilla client too — the menu is an ordinary chest / anvil screen, and the commands are ordinary server commands. ## Features ### sidebarRanking > Shows one of 13 stat types on the sidebar as a live ranking: blocks mined, blocks placed, ores mined, hostile kills, deaths, villager trades, crafting count, player level, ping, health, plus per-mob / per-block / per-item variants.

### realtimeUpdates > Ping, Health, and Player Level sync every 250 ms on a dedicated path. All other stats push within one tick (~50 ms) of block break, block place, mob kill, or crafting actions — no polling delay.

### chestMenuGui > Run `/hikari` to open a chest-shaped menu for switching stat type, browsing per-mob / per-block rankings, searching by Minecraft ID, and toggling display — no command memorization required. The search box borrows the anvil's rename field and matches the entry's Minecraft ID (`minecraft:diamond_ore`, or just `diamond_ore`), so modded entries stay reachable even when their display name differs.

### commandInterface > Every action is also available via `/hikari `. Includes stat switching, target selection (`@s` / `@a` / `@o` / ``), and administrative controls (`refresh` / `toplimit` / `fakeplayers` / `debug`) with OP2 gating. `/hikari toplimit` takes a value from **1 to 14** and sets how many ranking rows the **vanilla sidebar** shows; the Hikari-Tweaks HUD always receives the full list and pages through it client-side, so it is not affected.

### vanillaStatSourceOfTruth > Reads values directly from vanilla's `world/stats/*.json`, so imported existing worlds keep their statistics history intact. No custom counters, no drift, no divergence. Uninstalling this mod leaves your world data untouched.

### carpetFakePlayerDistinction > Bot players spawned via Carpet's `/player spawn` are automatically detected via UUID version (v3 offline-hash vs v4 Mojang) and can be excluded from rankings with `/hikari fakeplayers exclude`.

### discordForumIntegration > **Optional, and off until you configure it.** When enabled, the server posts rankings to a Discord Forum channel on a configurable interval, giving each stat its own dedicated thread and re-adopting existing threads after a restart. A `/refresh` slash command in Discord triggers an immediate update. Configured in `/data/hikariscoreboard/discord.properties` (`enabled`, bot token, forum channel ID, interval, row count); with no bot token and no channel ID the whole feature simply never starts.

### hikariTweaksIntegration > When [Hikari-Tweaks](https://modrinth.com/mod/hikari-tweaks) is installed on the client, that player gets a fully customizable HUD (position, scale, colors, pagination) instead of the vanilla sidebar. Hikari-Tweaks additionally eases changing numbers towards their new value rather than letting them jump. **That animation is a Hikari-Tweaks feature and runs entirely on the client**, in real time and on the `ranking_v2` delta path; this mod has no smoother of its own and always sends true values. Sorting and ranks always come from those true values, so rows never swap places mid-animation.

## Requirements - Minecraft **1.17.1 – 1.21.11** (28 versions, covered by 13 files — see below) - **Fabric Loader** >= 0.19.3 (the 1.18.2 build alone accepts >= 0.14.24) - **Fabric API** — on the server - Java, depending on your Minecraft version: - Minecraft **1.17.1** → Java **16** or newer - Minecraft **1.18 – 1.20.4** → Java **17** or newer - Minecraft **1.20.5** and later → Java **21** or newer ### Which file do I download? There are **13 files**. Each one covers the Minecraft versions whose API it is compatible with, so the version in the file name is not necessarily your server version — pick the row that contains it. Each file declares its own range, so a wrong pick is refused at startup rather than failing silently. | File | Covers | Java | |---|---|---| | `hikariscoreboard-+1.17.1.jar` | 1.17.1 | 16 | | `hikariscoreboard-+1.18.2.jar` | 1.18, 1.18.1, 1.18.2 | 17 | | `hikariscoreboard-+1.19.2.jar` | 1.19, 1.19.1, 1.19.2 | 17 | | `hikariscoreboard-+1.19.4.jar` | 1.19.3, 1.19.4 | 17 | | `hikariscoreboard-+1.20.1.jar` | 1.20, 1.20.1 | 17 | | `hikariscoreboard-+1.20.2.jar` | 1.20.2 | 17 | | `hikariscoreboard-+1.20.4.jar` | 1.20.3, 1.20.4 | 17 | | `hikariscoreboard-+1.20.6.jar` | 1.20.5, 1.20.6 | 21 | | `hikariscoreboard-+1.21.1.jar` | 1.21, 1.21.1 | 21 | | `hikariscoreboard-+1.21.4.jar` | 1.21.2, 1.21.3, 1.21.4 | 21 | | `hikariscoreboard-+1.21.8.jar` | 1.21.5, 1.21.6, 1.21.7, 1.21.8 | 21 | | `hikariscoreboard-+1.21.10.jar` | 1.21.9, 1.21.10 | 21 | | `hikariscoreboard-+1.21.11.jar` | 1.21.11 | 21 | > The file name is the version the build targets, not the only version it covers — the 1.21.8 build, for example, also covers 1.21.5 – 1.21.7. > Minecraft 1.17 itself is not supported; the earliest supported version is 1.17.1. > Use Modrinth's version filter to get the right file for your server. ## Optional Integrations - **[Hikari-Tweaks](https://modrinth.com/mod/hikari-tweaks)** (client-side, per player) — custom HUD with configurable position, scale, colors and pagination, plus smooth value animation - **Carpet Mod** — enables Carpet bot detection and exclusion - **Discord** — optional Forum posting; needs a bot token and a forum channel ID (see above) ## Credits Developed at **[光鯖 (Hikari Server)](https://hikariserver.com)** — a Minecraft Java Edition community. - **Maintainer**: [Tamago0314](https://github.com/Tamago0314) - **Contributor**: [Sim-hu](https://github.com/Sim-hu) ## License **All Rights Reserved.** The full terms ship inside the jar as `LICENSE`. Personal / private-server use only. Redistribution, publication, sale, and distribution of derivative works are not permitted without prior written permission from the copyright holder. You may, however, modify your own copy for your own use, and decompile the mod as far as is needed to debug those changes — both for private use only, and neither lets you distribute the result. The bundled third-party libraries are not covered by this and stay under their own licenses (see below). ### Third-party libraries The jar embeds several third-party libraries under `META-INF/jars/` (JDA and its dependencies, used for the optional Discord integration). Each is embedded unmodified and stays under its own license — Apache License 2.0 for most of them, and the GNU Lesser General Public License 2.1 for GNU Trove (`trove4j`). The complete list with versions, copyright notices and the full license texts ships inside the jar as `THIRD-PARTY-NOTICES.txt` and `licenses/`. Those licenses cover the embedded libraries only; they do not apply to HikariScoreBoard itself. ## Support & Links - **Homepage**: https://hikariserver.com - **Bug reports / questions**: https://discord.hikariserver.com/ - **Modrinth**: https://modrinth.com/mod/hikariscoreboard

HikariScoreBoard

Compatibility

Minecraft: Java Edition

Platforms

Supported environments

Links

Tags

Creators

Details

Scoreboard Display

Scoreboard Display