HyExtras | IN ALPHA STAGE 2 (1.0.2-alpha.2)

Extra Trigger Volume actions, conditions, packet-backed tools, and creator utilities for Hytale servers.

HyExtras is a modular creator and developer toolkit for Hytale servers. It extends the native Trigger Volume system with extra effects and conditions, per-player variables, persistent tags, cooldowns, packet-backed visibility features, command execution, volume chaining, floating item displays, NPC state tools, image icons, and more.

HyExtras is built for server owners, map makers, dungeon creators, MMO-style servers, quest systems, adventure maps, and developers who want more control without replacing Hytale’s native Trigger Volume workflow.

HyExtras does not replace the native Trigger Volume system.
It adds extra tools on top of it.

What Can HyExtras Do?

HyExtras gives creators and server developers more ways to react to player actions inside Trigger Volumes.

Use it to create things like:

Hidden dungeon entrances
One-time story triggers
Per-player puzzle progress
Private player-only interactions
Cooldown-based rewards
Conditional NPC logic
Story area visibility rules
Floating decorative item displays
Packet-backed titles, action bars, cameras, and visibility effects
Server-side MMO, quest, dungeon, and adventure mechanics

Main Features

Extra Trigger Volume Effects

HyExtras adds a large collection of extra Trigger Volume effects, including:

Set, add, calculate, and remove player variables
Apply named cooldowns
Run server commands
Send titles, rich messages, and reward messages
Give and remove item rewards
Push players back
Control camera and voice activity
Hide or show entities per player
Trigger named volumes
Enable or disable volumes
Add or remove persistent player tags
Add or remove volume tags
Block, allow, cancel, or modify interactions
Create, move, remove, and configure floating items
Apply tags and variables to NPCs or UUID-backed entities

Extra Trigger Volume Conditions

HyExtras also adds extra conditions so your Trigger Volumes can check for things before running effects.

Examples include:

Player variable checks
Cooldown readiness
Persistent tag checks
Math conditions
Operator checks
Player visibility checks
World time ranges
Interaction type checks
Volume tag checks
TagNPC state checks
Floating item existence checks

This makes it easier to build content that reacts differently for each player.

Per-Player State

HyExtras can track per-player data that works great for quests, dungeons, puzzles, and progression.

Supported state types include:

State Type	Use Case
Variables	Runtime counters, scores, temporary progress, puzzle states
Cooldowns	Reward timers, anti-spam logic, repeatable events
Visibility Overrides	Hide or show entities for specific players
Persistent Tags	Story flags, unlocks, completed objectives, long-term progression

Variables and cooldowns are runtime-only, while persistent tags are saved and survive restarts.

Packet-Backed Features

HyExtras includes optional packet-backed tools for advanced server content.

These can be used for:

Per-player visibility
Hide/show player or entity logic
Camera control
Titles and action bars
Volume visibility policy
NPC targeting protection
Story-area style packet rules

This is especially useful for MMO servers, story-driven servers, dungeon servers, and servers that need player-specific experiences.

Modular Design

HyExtras is split into internal modules so server owners can enable only what they need.

Current modules include:

TriggerExtras — extra Trigger Volume effects and conditions
PlaceholderAPI Bridge — %placeholder% support in HyExtras text
Packet API — packet-backed visibility, camera, titles, and helper systems
Image Icons — local and remote PNG/GIF icon support for developer mods
TagNPC — runtime tags, variables, and visibility for NPCs and mobs
Floating Items — decorative, non-pickup item displays

Most modules can be toggled or reloaded through config or /hextras commands.

Floating Items

Create decorative item displays that are not meant to be picked up.

Useful for:

Dungeon keys
Quest markers
Display rewards
Shop visuals
Floating collectibles
RPG-style environmental decoration

Floating items can be persistent, intangible, animated, and managed with commands.

TagNPC

TagNPC lets HyExtras track runtime state on UUID-backed NPCs, mobs, or entities.

You can use it to:

Add or remove runtime tags from NPCs
Store variables on NPCs
Hide or show NPCs to specific players
Build conditional NPC behavior
Support quest or dungeon state logic

This is useful for story content, interactive mobs, and server-side quest systems.

Image Icons

HyExtras includes an Image Icons system for developer mods.

It supports:

Provider-scoped image assets
Local PNG/GIF icons
Remote PNG/GIF icons
Hot reload support
Remote caching
Viewer radius limits
Icon limits per viewer

This is designed for developers who want reusable icon support across HyExtras-compatible systems.

Placeholder Support

HyExtras supports native placeholders like:

{player}
{uuid}
{variable:key}

Optional PlaceholderAPI support can also be enabled to resolve %placeholder% tokens when PlaceholderAPI for Hytale is installed.

Admin Commands

All HyExtras admin commands are under:

/hextras

Command groups include:

/hextras var
/hextras tag
/hextras cooldown
/hextras list
/hextras debug
/hextras modules
/hextras module
/hextras tagnpc
/hextras floatingitems
/hextras reload

These commands allow admins to manage player variables, tags, cooldowns, modules, TagNPC state, floating items, debugging, and runtime reloads.

Example Use Case

A hidden ruins area that greets a player once every 5 minutes and tracks visits:

{
  "conditions": [
    { "type": "cooldown_ready", "eventType": "ENTER", "Name": "ruins_intro" }
  ],
  "effects": [
    { "type": "apply_cooldown", "eventType": "ENTER", "Name": "ruins_intro", "Duration": 300.0 },
    { "type": "add_variable", "eventType": "ENTER", "Key": "ruins_visits", "Delta": 1 },
    { "type": "send_title", "eventType": "ENTER", "Title": "The Hidden Ruins", "Subtitle": "Visit #{variable:ruins_visits}" }
  ]
}

This kind of setup can be used for dungeons, story zones, tutorial areas, puzzle rooms, reward areas, and more.

Installation

Download hyextras-<version>.jar.
Place it into your Hytale server’s mods/ folder.
Start the server.
HyExtras will generate hyextras.properties on first run.
Optional: install PlaceholderAPI for Hytale to enable %placeholder% support.

Compatibility

Item	Supported
Hytale Server API	`0.5.x`
Built/Tested On	`0.5.6`
Manifest Range	`&gt;=0.5.0 &lt;0.6.0`
HyExtras Version	`1.0.2`
Java	`25`

Future Hytale 0.6.x releases should be treated as a new compatibility pass because server APIs may change.

Configuration

HyExtras uses:

hyextras.properties

The config is generated on first run and includes documented defaults.

Config options include:

Global packet feature toggles
Startup diagnostics
Debug mode
Module enable/disable settings
Placeholder behavior
Image icon cache settings
TagNPC visibility settings
Floating item defaults

You can reload the config at runtime with:

/hextras reload

For Developers

HyExtras includes a stable HyExtrasApi facade that other server mods can use for:

Player variables
Player tags
Cooldowns
Visibility helpers
Camera and title helpers
Rule evaluation
Image icons
TagNPC state
Floating items

Example:

HyExtrasApi api = HyExtrasApi.get();

api.setVariableString(playerUuid, "partyId", "alpha");
api.addTag(playerUuid, "storyline_a_active");
api.hidePlayerFrom(viewerUuid, targetUuid, true);
api.sendActionBar(playerUuid, "Party: " + api.getVariableString(playerUuid, "partyId"));

Useful Links

Disclaimer

HyExtras is an independent community project.

It is not affiliated with, endorsed by, sponsored by, or officially connected to Hypixel Studios. “Hytale” is a trademark of its respective owner.