BlackFlash Mod

BlackFlash adds a rare, high-impact critical strike to Hytale combat. Each player attack has a configurable chance to trigger a Black Flash, multiplying damage, playing a custom sound, showing a HUD notification, spawning blood particles, and displaying a custom hit-splat that shows the Black Flash damage value.

This mod is server-side and uses a JSON config file to let you tune the experience.

Features

1. Chance-based damage multiplier on player attacks.
2. Custom HUD notification (icon + text) when a Black Flash occurs.
3. Custom hit-splat showing the Black Flash damage value.
4. Optional sound effect on Black Flash.
5. Blood particle burst with configurable red/black mix.
6. Optional health and stamina recovery on Black Flash.
7. Streak multiplier: consecutive Black Flash hits scale damage even higher.
8. Colored streak chat message to the player when a streak continues.

Recommended Dependencies

To get the full experience, the MultipleHud mod is highly recommended. It helps ensure the custom HUD elements from BlackFlash display properly alongside other UI elements.

Streak Multiplier Example

With streakMultiplier set to 1.0, the streak scaling works like this:

1. Damage 20 = 20
2. Damage 20 + Black Flash = 20 x X
3. Damage 20 + 2 Black Flash in a row = 20 x 2 x X
4. Damage 20 + 3 Black Flash in a row = 20 x 3 x X
5. And so on…

Configuration

The config file is created automatically at: mods/BlackFlash/blackflash_config.json

Below is the default configuration and what each field does:

{
  "chancePercent": 0.05,
  "damageMultiplier": 100.0,
  "streakMultiplier": 1.0,
  "streakChatMessage": "{player} is on a Black Flash streak of: {streak}x",
  "enableNotification": true,
  "notificationMessage": "Black Flash! x{multiplier}",
  "notificationStyle": "Danger",
  "notificationIcon": "",
  "enableSound": true,
  "soundEventId": "black_flash",
  "soundVolume": 0.75,
  "healHealthPercent": 25.0,
  "healStaminaPercent": 25.0,
  "redParticlePercent": 50.0,
  "blackParticlePercent": 50.0,
  "hitSplatDurationSeconds": 0.5,
  "useCustomHud": true,
  "hudDurationSeconds": 3,
  "hudUiPath": "black_flash_notification.ui",
  "hudIconPath": "icons/black_flash_icon.png"
}

Field Details

1. chancePercent Chance (in %) for a Black Flash to trigger on each attack. Example: 0.05 = 0.05%.
2. damageMultiplier Multiplier applied to the attack damage when Black Flash triggers.
3. streakMultiplier Additional multiplier applied to the Black Flash streak count. (Multiplier 1.0 = 1 time: )
4. streakChatMessage Chat message template shown to the player on a Black Flash streak. Placeholders: {player}, {streak}.
5. enableNotification Enables the notification/HUD message on Black Flash.
6. notificationMessage Message text. Supports placeholders:
   • {multiplier}: damage multiplier
   • {base}: base damage
   • {damage}: final damage after multiplier
   • {chance}: chancePercent
7. notificationStyle Notification style when not using the custom HUD. Options: Default, Success, Warning, Danger.
8. notificationIcon Optional icon for the native notification.
9. enableSound Enables playing a sound on Black Flash.
10. soundEventId Sound event asset id. Default is black_flash.
11. soundVolume Volume for the Black Flash sound (0.0 to 1.0).
12. healHealthPercent Restores this % of max health when a Black Flash happens.
13. healStaminaPercent Restores this % of max stamina when a Black Flash happens.
14. redParticlePercent Percentage of red blood particles (0–100). Mixed with black.
15. blackParticlePercent Percentage of black blood particles (0–100). Mixed with red.
16. hitSplatDurationSeconds How long the Black Flash hit-splat remains visible.
17. useCustomHud When true, uses the custom HUD layout in hudUiPath.
18. hudDurationSeconds How long the custom HUD notification stays visible.
19. hudUiPath UI file used for the custom HUD.
20. hudIconPath Icon used in the custom HUD.

Tips

1. If Black Flash triggers too often, lower chancePercent.
2. If the sound is too loud, reduce soundVolume.
3. For more intense visuals, increase redParticlePercent and blackParticlePercent together.
4. If the hit-splat disappears too fast, increase hitSplatDurationSeconds.