Server documentation

EventBooster

In Development

Hytale • Version 0.2.1

Setup guide: staff permissions, commands (global and group boosts), configuration, integrations, and verifying XP.

This page is the full server administration guide for EventBooster v0.2.1. It covers permissions, commands, configuration, optional leveling integrations, and how to confirm boosts are working.

Installation

Download EventBooster-0.2.1.jar from the CurseForge Files tab
Place the JAR in your server’s mods/ folder
Start the server. Config is generated at plugins/EventBooster/config/config.json
Grant staff permissions (see Permissions below)
Run /eventboost start 2 10 and /eventboost status to verify

Recommended: install RPG Leveling and Stats alongside EventBooster for reliable XP multiplication.

Commands

Main command: /eventboost (aliases: /eb, /boost, /eventbooster)

Hytale requires two positional arguments for start (multiplier, minutes). All other options use flags (--name=value). Use /eventboost start --help in-game for the full list.

Command	Permission	Description
`/eventboost start <mult> <minutes> [flags]`	`eventbooster.admin.start`	Start a timed XP boost
`/eventboost stop [id\|all]`	`eventbooster.admin.stop`	Stop one boost or all
`/eventboost reload`	`eventbooster.admin.reload`	Reload config
`/eventboost status`	`eventbooster.status`	List active boosts
`/eventboost help`	Staff (see below)	Show command list

Start flags

Flag	Description
`--target=all`	Everyone online (default)
`--target=group`	Only players matching `--groups`
`--groups=VIP,hytale:Admin`	Comma-separated group names or permission nodes
`--label=...`	Display name in broadcasts and status
`--world=...`	Only apply boost in that world (name or uuid string)
`--id=...`	Boost id for stop/status (default: `global`)

Examples

/eventboost start 2 0
/eventboost start 2 120
/eventboost start 2 120 --target=all --label="Server-wide 2x"
/eventboost start 2 120 --target=group --groups=VIP --label="VIP Happy Hour"
/eventboost start 2 120 --target=group --groups=hytale:Admin
/eventboost start 1.5 60 --id=mining --world=world_mine --label="Mining Boost"
/eventboost stop mining
/eventboost stop all
/eventboost status

Boost targeting (v0.2.0)

EventBooster uses your server’s existing Hytale permissions. No separate rank plugin.

A player receives a group boost if:

They are in a listed group (PermissionsModule / permissions.json), or
They have a listed permission node

If --groups is set without --target=group, the mod treats it as a group boost automatically.

World filter (--world=...) can be combined with global or group boosts: only players in that world name get the multiplier.

Permissions

Only staff with the correct nodes can start, stop, or reload boosts. Players do not need permissions to receive XP from an active boost.

Permission	Description
`eventbooster.admin.start`	Start boost events
`eventbooster.admin.stop`	Stop boost events
`eventbooster.admin.reload`	Reload config
`eventbooster.admin`	All admin actions (parent node)
`eventbooster.status`	View active boosts

/eventboost help is staff only (v0.2.1): players need eventbooster.status, eventbooster.admin, or any eventbooster.admin.* node. Normal players without those permissions cannot run /eb help or /eventboost help.

To allow everyone to read help (optional), set "allowPublicHelp": true in config.json.

Quick setup with Hytale /perm

/perm group add OP eventbooster.admin

Or individual nodes:

/perm group add OP eventbooster.admin.start
/perm group add OP eventbooster.admin.stop
/perm group add OP eventbooster.admin.reload
/perm group add OP eventbooster.status

permissions.json example

{
  "groups": {
    "OP": {
      "permissions": [
        "eventbooster.admin"
      ]
    },
    "VIP": {
      "permissions": []
    }
  }
}

Put VIP players in the VIP group in your save’s user permissions, then run:

/eventboost start 2 120 --target=group --groups=VIP

Configuration

Config file: plugins/EventBooster/config/config.json (configVersion 2 in new installs)

Boost limits

Option	Default	Description
`minMultiplier`	`1.0`	Minimum allowed boost multiplier
`maxMultiplier`	`10.0`	Maximum allowed boost multiplier
`maxCombinedMultiplier`	`10.0`	Cap when multiple boosts stack
`defaultDurationMinutes`	`60`	Reference default (start uses `0` for permanent)
`allowConsoleCommands`	`false`	Allow server console to run admin commands without a player
`allowPublicHelp`	`false`	If `true`, any player can use `/eventboost help`
`defaultMultiplier`	`2.0`	Reference default
`maxDurationMinutes`	`10080`	Maximum event duration (minutes)

Messaging

Option	Default	Description
`broadcastOnStart`	`true`	Broadcast when a boost starts
`broadcastOnEnd`	`true`	Broadcast when a boost ends
`notifyPlayerOnJoin`	`true`	Remind joining eligible players
`reminderIntervalMinutes`	`15`	Periodic reminder interval (0 = off)
`startBroadcastFormat`	(see config)	Placeholders: `{label}`, `{duration}`, `{multiplier}`, `{target}`
`endBroadcastFormat`	(see config)	Placeholders: `{label}`, `{target}`
`joinNoticeFormat`	(see config)	Placeholders: `{label}`, `{remaining}`, `{target}`
`statusLineFormat`	(see config)	Placeholders: `{id}`, `{label}`, `{multiplier}`, `{remaining}`, `{target}`
`partyProHudFormat`	`BOOST {multiplier}x`	PartyPro HUD text when boost applies to that player

Messages are sent only to players eligible for that boost (v0.2.0).

Integrations

Option	Default	Description
`integrationRpgLeveling`	`true`	Hook RPG Leveling XP listener
`integrationHyRpgCore`	`true`	Hook HyRPGCore internal xpService
`integrationVkCraft`	`true`	Hook VKCraft skill XP delta booster
`integrationPartyProHud`	`true`	Per-player PartyPro HUD text

Optional integrations

Mod	Role
RPG Leveling and Stats	Primary XP hook (recommended)
HyRPGCore	Internal xpService hook via reflection
VKCraft	Skill XP delta booster
PartyPro	HUD indicator per eligible player

No leveling mod is required. Without one, commands, timers, and broadcasts still work, but in-game XP will not change.

Check server log on startup:

EventBooster started. Active integrations: RPGLeveling, ...

Verifying XP boosts

Start server with EventBooster + a leveling mod (RPG Leveling recommended)
Global test: run /eventboost start 10 10. All players should gain boosted XP.
Group test: run /eventboost start 10 10 --target=group --groups=VIP. Only VIP-group players are boosted.
Run /eventboost status and confirm [target] in the line
Run /eventboost stop or wait for expiry. Eligible players should see the end broadcast when the boost actually ends (v0.2.1).

Public API

if (EventBoosterAPI.isAvailable()) {
    double multiplier = EventBoosterAPI.get()
            .getExperienceMultiplier(playerUuid, worldName);
}

Use the UUID overload for correct results when group boosts are active.

Notes

/eventboost reload reloads config and re-attaches integrations safely (v0.2.1). Restart the server if you disable an integration in config and need hooks fully removed.
Internal hooks (HyRPGCore, VKCraft) may need updates when those mods change internals.