β‘ HX Core β Version 1.0.0
The fundamental backbone, central API & in-game management system for the entire HX Server Network.
π What is HX Core?
HX Core is the foundational building block of the modular HX Server Suite for Minecraft NeoForge (1.21.1). It interconnects individual servers into a unified, synchronized network and provides a high-performance cross-server Redis engine, a complete permission registry, persistent user management (HXUser), and a state-of-the-art In-Game Admin Dashboard (/hxadmin).
Whether you run a single survival server or an expansive multi-server network: HX Core centralizes data, synchronizes players and chats in real time, and gives server administrators an intuitive in-game interface to manage and monitor every module directly inside Minecraft!
β¨ Key Features
ποΈ 1. Comprehensive In-Game Admin Dashboard (/hxadmin)
Leave clunky server consoles and cryptic config files behind! Executing /hxadmin (or pressing H / your configured admin key) opens a sleek, cyber-themed management dashboard featuring 9 dedicated modules:
- π Network & Server Status: Real-time health statistics across all connected servers (TPS, MSPT, player counts, RAM utilization).
- π€ Discord Bot & Event Center: Full control over Discord bot synchronization, status, webhooks, join-wall verification, and chat bridges.
- π§ Maintenance Mode & Reboot Manager: Server-wide or network-wide maintenance toggles with visual countdown timers (e.g. 60s, 15 min), whitelisted bypass ranks/UUIDs, and customizable disconnect messages.
- π Ranks & Permissions: Interactive rank editor (weights, prefixes, colors) and a built-in permission explorer to inspect all registered mod permissions.
- π₯ Community & Profiles: Live overview of registered players, coin balances, Discord verification status, and profile badge management.
- π€ Server Helper Integration: Control chat announcements, automated item and XP clear sweeps, and lag prevention thresholds.
- π Tablist Designer: Live editing of tablist header and footer templates with dynamic formatting and animation tags.
- π° Patchnotes & Roadmap: In-game update news and development roadmap entries with color-coded tags (
+,*,-,!). - π« Support Ticket System: Review, prioritize, reply to, and resolve player support tickets directly within the game.
π 2. Cross-Server Redis Engine & Real-Time Synchronization
- Network-Wide Player Database: Lightning-fast synchronization of UUIDs, player names, coin balances, ranks, custom metadata, and online states via Redis Pub/Sub.
- Cross-Server Chat & Events: Broadcasts messages, joins, leaves, deaths, advancements, and server alerts instantly across your entire network.
- Leader Election & Failover: Automatically negotiates an active master server to run centralized background workloads (such as the primary Discord bot gateway). If the master goes offline, another node immediately steps in!
π‘οΈ 3. Modular Permission & Authorization System
- Central Permission Registry: All HX modules automatically register their permission nodes during startup via
HXCoreAPI.registerPermission. - Hierarchical Evaluation: Supports default assignment tiers (
TRUEfor everyone,FALSEfor nobody,OPfor server operators at permission level 2+). - Bypass & Admin Overrides: Granular exception permissions for maintenance bypass, profile editing, global broadcasts, and command logging.
π§© 4. Extensible Developer API (HXCoreAPI)
For mod developers and third-party integrations, hx_core provides a clean, versioned Java API:
- Register Custom Dashboard Tabs:
HXCoreAPI.registerDashboardTab("my_mod", "My Mod", "β", player -> { JsonObject data = new JsonObject(); data.addProperty("status", "active"); return data; }, (admin, action, payload) -> { // Handle GUI button clicks and payload actions return "Action executed successfully!"; }); - Query & Modify Player Data:
HXUser user = HXCoreAPI.getUser(playerUuid); user.addCoins(500); HXCoreAPI.syncUser(user); - Broadcast Network-Wide Messages:
HXCoreAPI.broadcastNetworkMessage("&a[Network] A new server event has started!");
π» Client & Server Roles
| Environment | Requirement | Purpose |
|---|---|---|
| Dedicated Server | β Required | Manages all backend operations, Redis pub/sub channels, and user persistence. |
| Admin Client | β Recommended | Required to open and interact with the graphical Admin Dashboard (/hxadmin). |
| Player Client | πΉ Recommended | Acts as the core library for dependent client-side mods (e.g. hx_community). |
β¨οΈ Commands & Permissions
| Command | Permission | Description |
|---|---|---|
/hxadmin |
hx.admin.dashboard (OP 2) |
Opens the interactive In-Game Admin Dashboard. |
/hxadmin reload |
hx.admin.dashboard (OP 2) |
Reloads local configurations and flushes network caches. |
/user <Player> |
hx.admin.user (OP 2) |
Displays detailed user profile and metadata from the database. |
/coins <Player> |
hx.core.coins (Default) |
Checks the current coin balance of a player. |
/pay <Player> <Amount> |
hx.core.coins (Default) |
Transfers coins to another online player. |
βοΈ Configuration (config/hx_core/)
The configuration directory is automatically generated upon first server startup:
redis.json: Redis connection credentials (host, port, password, channel prefix).users/: Local JSON cache for player profiles (ensures uninterrupted operation during offline/fallback states).news.json: In-game patchnotes and roadmap entries.tickets.json: Persistent storage for support tickets.
π¦ The Modular HX Ecosystem
hx_core serves as the foundation for the following companion mods:
- π₯ HX Community: Interactive 3D player profiles (Key
P), social cards, custom bio status, badges, and secure player trading (/trade). - π€ HX Discord Status: Live Discord embeds, player status cards, bi-directional chat bridge, and Discord verification.
- π οΈ HX Server Helfer: Automatic item and entity clear sweeps, AFK auto-kicks, server uptime, and broadcast alerts.
- π§ HX Maintenance: Maintenance mode with countdown timers, whitelist bypass, and automated kick protection.
- π HX Tab: Dynamic animated tablists with TrueColor gradients and live server statistics.
- π HX Ranks: Network-wide rank, prefix, and permission management.
Β© WolfsblutHX β Developed for the HX Server Network.

