Overview#
The StatusEffectHUD mod, developed by bspkrs, enhances the player's experience by providing a clear and immediate visual representation of all active potion and status effects. Instead of pausing gameplay to check the inventory screen, players can see their current buffs and debuffs, along with their remaining durations, directly on the heads-up display. This client-side modification is particularly useful during intense combat or exploration, allowing players to track critical effects like Regeneration, Strength, or Poison without interruption.
Mechanics#
The core functionality of StatusEffectHUD is to render a customizable display of active status effects on the screen. Each effect is typically shown with its corresponding icon, name, and remaining duration.
Key mechanical features include:
- Real-time Display: Effects are shown as they become active, updating dynamically as durations tick down.
- Visual Consistency: The mod aims to match the aesthetic of the default potion effects display found in the inventory.
- Dynamic Expansion: When multiple effects are active, the HUD intelligently expands to accommodate all of them, typically stacking vertically or horizontally depending on configuration.
- Blinking Icons: A configurable option allows effect icons to blink when their duration is nearing its end, providing a visual warning to the player.
- Inventory Integration: The mod offers an option to hide the default potion effects display from the inventory screen, preventing redundant information.
- Beacon Effects: The HUD also accurately displays effects granted by beacons.
Configuration#
StatusEffectHUD offers extensive customization options, allowing players to tailor the display to their preferences. Configuration can be managed through a dedicated configuration file, typically located at config/StatusEffectHUD.cfg, or via an in-game graphical user interface (GUI). The in-game GUI can be accessed by typing the command /statuseffect config in chat.
Available configuration options include:
- Positioning: Players can adjust the exact on-screen alignment and position of the HUD using X and Y offset settings.
- Background Box: The background box behind the effect icons can be toggled on or off.
- Effect Names: The display of effect names can be enabled or disabled.
- Text Color: The color of the effect names and durations can be customized using standard Minecraft formatting codes.
- Duration Display: Options to control how the duration is displayed, including whether it shows seconds, minutes, or a combination.
- Icon Blinking Threshold: The time remaining before an effect icon starts blinking can be set.
- Version Update Checker: An integrated version update checker can be disabled if desired.
- Visibility in Chat: The HUD can be configured to remain visible even when the chat screen is open.
- Amplifier Display: The strength or amplifier of potion effects (e.g., Speed II) is also displayed.