Work in ProgressThis documentation is currently under active development.

Configuration Guide

Damage Indicators

Configure damage indicators, formats, and visual effects for different damage types

Simple Damage Formats

Basic damage indicator formats for different types of damage

Simple formats provide an easy way to customize how damage appears above entities. Each damage type can have its own unique appearance with colors, gradients, and emojis.

Basic Format Configuration

config.yml
damage-indicator: "simple-damage-formats" # Default damage indicator format

simple-damage-formats:
  default: "<gradient:#FF6B6B:#FF8787>-%.1f ā¤</gradient>"
  critical: "<bold><gradient:#FF0000:#8B0000>-%.1f ⚔</gradient></bold>"
  poison: "<gradient:#50C878:#228B22>-%.1f ☠</gradient>"
  fire: "<gradient:#FFD700:#FF4500>-%.1f šŸ”„</gradient>"
  magic: "<gradient:#9400D3:#800080>-%.1f ✨</gradient>"
  heal: "<green>+%.1f ā¤"

Use %.1f as a placeholder for the damage amount. The .1f means it will show one decimal place.

Format Tips

You can use %.0f for whole numbers,%.2f for two decimal places, etc. Combine with formatting tags like <bold> and<italic> for more customization.

Group-Based Formats

Permission-based damage indicator formats

Group formats allow different players to have different damage indicator styles based on their permissions. This is perfect for creating unique visual effects for donors, staff, or different player classes.

Group Format Configuration

config.yml
group-damage-formats:
  default: # Used when no permission matches
    # You can either define specific formats here or use simple-damage-formats
    use-simple-formats: true # Set to true to use simple-damage-formats instead of defining formats here
    damage-formats: # These will be used only if use-simple-formats is false
      default: "<gradient:#FF6B6B:#FF8787>-%.1f ā¤</gradient>"
      
  water:
    permission: "vitalstrike.group.water"
    damage-formats:
      default: "<gradient:#1E90FF:#00BFFF>-%.1f šŸ’§</gradient>"
      critical: "<bold><gradient:#0000FF:#000080>-%.1f 🌊</gradient></bold>"
      
  fire:
    permission: "vitalstrike.group.fire"
    damage-formats:
      default: "<gradient:#FF4500:#FF8C00>-%.1f šŸ”„</gradient>"
      critical: "<bold><gradient:#FF0000:#8B0000>-%.1f āš”</gradient></bold>"

Players will see the format from the first group where they have the required permission.

Default Group

The default group is used when a player doesn't have permission for any other group. Setting use-simple-formats: true will make it use your simple formats.

Custom Groups

Create as many custom groups as you need. Each group needs a unique permission node and can override any damage type format.

Damage Types

Configure formats for specific damage types

VitalStrike supports all Minecraft damage types, allowing you to create unique visual indicators for each type of damage a player can receive. This helps players quickly identify what's damaging them.

Damage Type Formats

config.yml
simple-damage-formats:
  # Environmental damage types
  fall: "<gradient:#A9A9A9:#696969>-%.1f šŸ’Ø</gradient>"
  drown: "<gradient:#1E90FF:#0000CD>-%.1f šŸ’§</gradient>"
  explosion: "<gradient:#FF4500:#8B0000>-%.1f šŸ’„</gradient>"
  contact: "<green>-%.1f 🌵"
  cramming: "<gray>-%.1f šŸ“¦"
  dragon: "<dark_purple>-%.1f šŸ‰"
  dryout: "<yellow>-%.1f 🌊"
  sweep: "<red>-%.1f āš”"
  falling_block: "<gray>-%.1f 🧱"
  wall: "<gray>-%.1f šŸ’«"
  freeze: "<aqua>-%.1f ā„"
  hot_floor: "<gold>-%.1f šŸ”„"
  lava: "<dark_red>-%.1f šŸŒ‹"
  lightning: "<yellow>-%.1f ⚔"
  projectile: "<gray>-%.1f šŸ¹"
  sonic_boom: "<dark_aqua>-%.1f šŸ“¢"
  starvation: "<gold>-%.1f šŸ–"
  suffocation: "<gray>-%.1f ⬛"
  thorns: "<green>-%.1f 🌹"
  void: "<dark_gray>-%.1f ⬇"
  wither: "<dark_gray>-%.1f šŸ’€"
  border: "<red>-%.1f 🌐"

Each damage type can have its own unique format and emoji indicator to help players quickly identify what's damaging them.

Environmental

  • Fall damage
  • Drowning
  • Suffocation
  • Fire & Lava
  • Void damage

Combat

  • Melee attacks
  • Projectiles
  • Explosions
  • Magic damage
  • Thorns damage

Special

  • Dragon breath
  • Sonic boom
  • World border
  • Lightning
  • Wither effect

Custom Sounds

Configure sounds for different damage types

Enhance the player experience by adding custom sounds for each damage type. When a player takes damage, they'll hear a sound that matches the damage source.

Sound Configuration

config.yml
damage-type-sounds:
  entity_attack: "entity.player.attack.strong"
  critical: "entity.player.attack.crit"
  poison: "entity.spider.hurt"
  fire: "block.fire.ambient"
  fire_tick: "block.fire.ambient"
  kill: "entity.player.death"
  magic: "entity.illusioner.cast_spell"
  fall: "entity.player.small_fall"
  drowning: "block.water.ambient"
  block_explosion: "entity.generic.explode"
  entity_explosion: "entity.generic.explode"
  contact: "block.grass.break"
  cramming: "entity.player.hurt"
  dragon_breath: "entity.ender_dragon.growl"
  dryout: "block.water.ambient"
  entity_sweep_attack: "entity.player.attack.sweep"
  falling_block: "block.stone.break"
  fly_into_wall: "entity.player.hurt"
  freeze: "block.glass.break"
  hot_floor: "block.fire.ambient"
  lava: "block.lava.ambient"
  lightning: "entity.lightning_bolt.thunder"
  projectile: "entity.arrow.hit"
  sonic_boom: "entity.warden.sonic_boom"
  thorns: "block.sweet_berry_bush.hurt"
  void: "entity.player.hurt"
  wither: "entity.wither.ambient"
  world_border: "entity.elder_guardian.curse"

Use Minecraft sound IDs to specify the sounds. These are the same IDs used in commands like /playsound.

Sound Volume & Pitch

By default, sounds play at normal volume and pitch. In future updates, you'll be able to customize volume and pitch for each sound type.

šŸ“

Formatting Guide

Learn how to use color codes and formatting tags

VitalStrike supports two different formatting systems: MiniMessage format and traditional Minecraft color codes. Here's how to use both systems to create beautiful damage indicators.

MiniMessage Format

Modern tag-based format with support for gradients and advanced formatting.

<red>Text</red> - Red text
<bold>Text</bold> - Bold text
<gradient:#FF0000:#0000FF>Text</gradient> - Gradient

Minecraft Color Codes

Traditional color codes using the ampersand (&) symbol.

&c - Red text
&l - Bold text
&c&l - Bold red text

Example Formats

config.yml
# MiniMessage Examples
simple-damage-formats:
  example1: "<red>-%.1f ā¤</red>"
  example2: "<bold><blue>-%.1f</blue></bold>"
  example3: "<gradient:red:gold>-%.1f āš”</gradient>"
  example4: "<italic><gradient:green:aqua>-%.1f</gradient></italic>"

# Minecraft Color Code Examples
simple-damage-formats:
  example5: "&c-%.1f ā¤"
  example6: "&l&9-%.1f"
  example7: "&6-%.1f &eāš”"
  example8: "&o&a-%.1f"

We recommend using MiniMessage format for the most flexibility and visual options.