← Back to documentation

Server documentation

BuffLedger

Active

Hytale • Version 0.1.0

Install, commands, HUD behavior, optional mod compatibility, and known limitations.

BuffLedger shows timed buffs and debuffs in a HUD with names and countdowns.


Overview

BuffLedger reads the server-side EffectControllerComponent and renders a small custom HUD with effect names and countdown timers. Tracking starts automatically when you join a world. The overlay only appears while at least one timed effect is active.


Installation

  1. Download BuffLedger-0.1.0.jar from the CurseForge Files tab
  2. Place the JAR in mods/ (global UserData/Mods or per-save mods/)
  3. Join the world — tracking is on by default
  4. Eat food or drink a potion to see the HUD
  5. Run /buffs status to verify tracking and effect count

Quick start

  1. Join a world (no /buffs on needed).
  2. Gain a timed buff or debuff.
  3. HUD appears bottom-left with lines like +HP Regen T3 4:32 or -Poison 12s.
  4. When all timed effects end, the HUD hides automatically.
  5. /buffs off opts out until /buffs on or delete opted_out.txt in mod data.

Commands

CommandDescription
/buffs onRe-enable tracking after opt-out
/buffs offStop tracking; persists opt-out
/buffs statusTracking on/off, HUD visible, active effect count
/buffs listPrint active effects in chat (debug without HUD)

HUD behavior

BehaviorDetail
Auto-trackingEnabled on PlayerReady unless opted out
VisibilityHUD only while EffectController has timed effects
RefreshAbout once per second on the world thread
PositionBottom-left above hotbar (Durkz_BuffLedger_Hud.ui)
LinesUp to 7 effect lines plus header

Optional mod compatibility

No hard dependencies. BuffLedger uses the same vanilla effect pipeline as these mods.

MultipleHUD (Buuz135)

TopicDetail
PurposeExtra custom HUD slot when running multiple HUD mods
Required?No
LimitationUses native addCustomHud when MultipleHUD is absent

Not Enough Potions (NEP)

TopicDetail
DetectionAutomatic via ApplyEffect + EntityEffect JSON
LabelsReadable names for NEP potions and Potion_Morph_*
LimitationMorph potions run CleanseMorph first (clears all effects). HUD timers can stall or freeze during the gap before the new morph registers. Some dragon morphs may fail to apply — independent of BuffLedger

BuffStacks (BeyondSmash)

TopicDetail
DetectionSame EffectController; stack count when multiple slots share one effect ID
LimitationBuffStacks does not track morph effects. Duplicate status icons are from BuffStacks, not BuffLedger

MoreFood / SNIP3 FoodPack

TopicDetail
DetectionAutomatic — asset packs using vanilla ApplyEffect
LabelsTier labels (Stamina T4, Fire Resist (Medium), etc.)

Known issues (0.1.0)

  • Morph potion transitions (NEP CleanseMorph) can pause HUD countdowns
  • /buffs list prints active effects in chat when the HUD layout looks wrong

Data files

PathPurpose
mods/durkz_BuffLedger/opted_out.txtPlayer UUIDs who used /buffs off

  • MultipleHUD if you run several HUD mods alongside BuffLedger.
  • /buffs list prints active effects in chat when the HUD layout looks wrong.

Verifying it works

  1. Join a world; /buffs status should show tracking on.
  2. Eat food or drink a potion; HUD appears with countdown lines.
  3. /buffs off hides tracking until /buffs on or delete opted_out.txt.

License

MIT License