Modular server essentials for Hytale. Part of the HyperSystems plugin suite.
HyperEssentials consolidates essential server functionality into a single modular plugin with 10 modules, 46 commands, and 50+ permission nodes. Each module can be independently enabled or disabled.
| Module | Features | Default | Status |
|---|---|---|---|
| Warmup | Universal warmup/cooldown system for all teleport actions | Enabled | Implemented |
| Homes | Home CRUD, sharing, bed sync, faction territory restrictions | Enabled | Implemented |
| Warps | Warp CRUD, categories, custom permissions per warp | Enabled | Implemented |
| Spawns | Spawn CRUD, per-world spawns, group routing, respawn teleport | Enabled | Implemented |
| Teleport | TPA requests, /back history, random teleport (RTP) | Enabled | Implemented |
| Kits | Kit creation from inventory, cooldowns, one-time claims, per-kit permissions | Disabled | Implemented |
| Moderation | Ban, tempban, mute, tempmute, kick, freeze, vanish, punishment history | Disabled | Implemented |
| Utility | Heal, fly, god mode, clear chat, clear inventory, repair, near | Disabled | Implemented |
| Announcements | Scheduled broadcasts, announcement rotation, manual broadcast | Disabled | Implemented |
| Vanish | Standalone vanish module (vanish is also available via Moderation) | Enabled | Stub |
- Hytale Server (latest release)
- Java 25+
- HyperPerms — Advanced permission management (chain-of-responsibility resolution)
- HyperFactions — Territory-aware home restrictions
- VaultUnlocked — Economy integration
- LuckPerms — Permission provider fallback
- Download
HyperEssentials-<version>.jarfrom Releases - Place in your server's
mods/directory - Restart the server
- Configuration files will be generated in
mods/com.hyperessentials_HyperEssentials/
HyperEssentials uses a split configuration system with per-module config files:
config.json— Core settings (prefix, colors, admin, storage)config/homes.json— Home module (limits, bed sync, faction restrictions)config/warps.json— Warp module (default category)config/spawns.json— Spawn module (default spawn, join/respawn teleport)config/teleport.json— TPA and RTP settings (timeouts, back history, RTP radius)config/warmup.json— Per-module warmup/cooldown timersconfig/kits.json— Kit module (default cooldown, one-time claims)config/moderation.json— Moderation (default reasons, broadcast toggles, freeze interval)config/vanish.json— Vanish (fake join/leave messages)config/utility.json— Utility commands (per-command toggles, radius limits)config/announcements.json— Announcement rotation (interval, randomize, messages)config/debug.json— Debug logging (per-category toggles)
See docs/commands.md for the complete command reference with all 46 commands, permissions, and aliases.
| Module | Commands |
|---|---|
| Admin | /hessentials reload|version |
| Homes | /sethome, /home, /delhome, /homes |
| Warps | /warp, /setwarp, /delwarp, /warps, /warpinfo |
| Spawns | /spawn, /setspawn, /delspawn, /spawns, /spawninfo |
| Teleport | /tpa, /tpahere, /tpaccept, /tpdeny, /tpcancel, /tptoggle, /back, /rtp |
| Kits | /kit, /kits, /createkit, /deletekit |
| Moderation | /ban, /tempban, /unban, /mute, /tempmute, /unmute, /kick, /freeze, /vanish, /punishments |
| Utility | /heal, /fly, /god, /clearchat, /clearinventory, /repair, /near |
| Announcements | /broadcast, /announce |
See docs/permissions.md for the complete permission reference. All nodes use the hyperessentials prefix.
Detailed documentation is available in the docs/ directory:
| Document | Description |
|---|---|
| Architecture | Package structure, module lifecycle, cross-module communication |
| Commands | All 46 commands organized by module |
| Config | Configuration reference for core and all modules |
| Permissions | Permission nodes organized by module |
| Modules | Module system overview, enable/disable, lifecycle |
| Storage | Storage providers, JSON format, data directory layout |
| Integrations | HyperPerms, HyperFactions, VaultUnlocked integration |
./gradlew :HyperEssentials:shadowJarOutput: HyperEssentials/build/libs/HyperEssentials-<version>.jar
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.