EchoingDeaths.docs

Configuration

EchoingDeaths generates plugins/EchoingDeaths/config.yml on first boot with every setting below. Edit the file, then run /echoingdeaths reload, no restart needed. Color codes use the classic &a&f style, and messages accept %player% / %cause% placeholders.

settings

KeyTypeDefaultDescription
settings.enabledbooleantrueMaster toggle for the whole plugin.
settings.radiusnumber14Radius (blocks) around the dead player in which nearby players get cursed.
settings.affect-creativebooleanfalseWhether creative-mode players receive curse effects.
settings.affect-spectatorbooleanfalseWhether spectator-mode players receive curse effects.
settings.ignored-worldsstring list["example_world"]Worlds where the plugin does nothing.

display

KeyTypeDefaultDescription
display.chat-messagebooleantrueSend the messages.chat lines.
display.actionbar-messagebooleantrueSend the messages.actionbar lines.
display.title-messagebooleantrueSend the title + subtitle.
display.sound-enabledbooleantruePlay the curse sound.
display.sound.typeSound enumENTITY_WARDEN_HEARTBEATBukkit Sound enum name; invalid names are ignored.
display.sound.volumenumber1.0Sound volume.
display.sound.pitchnumber0.8Sound pitch.

messages

KeyTypeDefaultDescription
messages.chatstring list3 linesChat lines sent to each cursed player, in order. Supports %player%, %cause%, color codes.
messages.actionbarstring list1 lineActionbar lines sent to each cursed player.
messages.title.titlestring&4Echoing DeathTitle text.
messages.title.subtitlestring&cYou feel a lingering curse...Subtitle text.
messages.title.fade-inint (ticks)10Title fade-in time.
messages.title.stayint (ticks)50Title stay time.
messages.title.fade-outint (ticks)20Title fade-out time.

effects

Each key under effects is a Bukkit DamageCause enum name; each value is a curse with this schema:

KeyTypeDescription
display-namestringReadable curse name, substituted into %cause%.
duration-secondsintHow long each potion effect lasts (converted to ticks server-side).
amplifierintPotion amplifier: 0 = Level I, 1 = Level II, 2 = Level III.
potion-effectsstring listBukkit PotionEffectType enum names; invalid entries are skipped.

The sixteen default curses and their values are catalogued on the Curses page.

fallback

Uses the same schema as an effects entry and applies to any death whose cause has no mapping (default: WEAKNESS I for 5 seconds, displayed as "Unknown").

Full default config.yml

The complete file generated on first boot. Copy it as a starting point:

# ============================================================
#                       EchoingDeaths
# ============================================================
#
# A lightweight Spigot/Paper/Purpur plugin that applies
# temporary curse-like debuffs to nearby players whenever
# someone dies.
#
# Designed for:
# - Spigot
# - Paper
# - Purpur
# - 1.21.x+
#
# ============================================================
#                        SETTINGS
# ============================================================
#

settings:

  # Master toggle for the plugin.
  enabled: true

  # Radius around the dead player where nearby
  # players will be affected.
  radius: 14

  # Whether players in creative mode should
  # receive curse effects.
  affect-creative: false

  # Whether players in spectator mode should
  # receive curse effects.
  affect-spectator: false

  # Worlds where the plugin should not work.
  ignored-worlds:
    - "example_world"

#
# ============================================================
#                       DISPLAY SETTINGS
# ============================================================
#

display:

  # Send normal chat messages.
  chat-message: true

  # Send actionbar messages.
  actionbar-message: true

  # Send title/subtitle messages.
  title-message: true

  # Play sound effects.
  sound-enabled: true

  sound:

    # Bukkit sound enum.
    #
    # You can find valid sounds here:
    # https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
    #
    type: ENTITY_WARDEN_HEARTBEAT

    volume: 1.0

    pitch: 0.8

#
# ============================================================
#                         MESSAGES
# ============================================================
#
# Color Codes:
#
# &0 = Black
# &1 = Dark Blue
# &2 = Dark Green
# &3 = Dark Aqua
# &4 = Dark Red
# &5 = Purple
# &6 = Gold
# &7 = Gray
# &8 = Dark Gray
# &9 = Blue
# &a = Green
# &b = Aqua
# &c = Red
# &d = Pink
# &e = Yellow
# &f = White
#
# Placeholders:
#
# %player% = Dead player
# %cause%  = Death cause display name
#
# ============================================================
#

messages:

  #
  # Chat messages sent to affected players.
  #
  chat:
    - "&4%player% died."
    - "&cYou were cursed by the echo of their death."
    - "&7Cause: &e%cause%"

  #
  # Actionbar message.
  #
  actionbar:
    - "&cCursed by %player%'s death"

  #
  # Title settings.
  #
  title:

    title: "&4Echoing Death"

    subtitle: "&cYou feel a lingering curse..."

    # Timing in ticks.
    fade-in: 10

    stay: 50

    fade-out: 20

#
# ============================================================
#                     DEATH EFFECTS
# ============================================================
#
# Structure:
#
# EFFECT_NAME:
#
#   display-name:
#     Readable cause name.
#
#   duration-seconds:
#     Effect duration.
#
#   amplifier:
#     Potion amplifier level.
#     0 = Level I
#     1 = Level II
#     2 = Level III
#
#   potion-effects:
#     Bukkit potion effect enums.
#
# Valid potion effects:
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html
#
# ============================================================
#
#
# Valid damage causes:
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageEvent.DamageCause.html


effects:

  FALL:

    display-name: "Fall"

    duration-seconds: 10

    amplifier: 1

    potion-effects:
      - SLOWNESS
      - WEAKNESS

  LAVA:

    display-name: "Lava"

    duration-seconds: 12

    amplifier: 1

    potion-effects:
      - WEAKNESS
      - NAUSEA
      - HUNGER

  FIRE:

    display-name: "Fire"

    duration-seconds: 8

    amplifier: 1

    potion-effects:
      - WEAKNESS
      - HUNGER

  DROWNING:

    display-name: "Drowning"

    duration-seconds: 10

    amplifier: 1

    potion-effects:
      - MINING_FATIGUE
      - SLOWNESS

  VOID:

    display-name: "Void"

    duration-seconds: 8

    amplifier: 0

    potion-effects:
      - DARKNESS
      - BLINDNESS

  MAGIC:

    display-name: "Magic"

    duration-seconds: 12

    amplifier: 1

    potion-effects:
      - BLINDNESS
      - WEAKNESS

  WITHER:

    display-name: "Wither"

    duration-seconds: 10

    amplifier: 1

    potion-effects:
      - WITHER
      - HUNGER

  EXPLOSION:

    display-name: "Explosion"

    duration-seconds: 8

    amplifier: 1

    potion-effects:
      - NAUSEA
      - WEAKNESS

  FREEZE:

    display-name: "Freezing"

    duration-seconds: 12

    amplifier: 1

    potion-effects:
      - SLOWNESS
      - WEAKNESS

  LIGHTNING:

    display-name: "Lightning"

    duration-seconds: 8

    amplifier: 1

    potion-effects:
      - GLOWING
      - NAUSEA

  POISON:

    display-name: "Poison"

    duration-seconds: 12

    amplifier: 1

    potion-effects:
      - POISON
      - HUNGER

  STARVATION:

    display-name: "Starvation"

    duration-seconds: 15

    amplifier: 0

    potion-effects:
      - HUNGER
      - WEAKNESS

  SUFFOCATION:

    display-name: "Suffocation"

    duration-seconds: 10

    amplifier: 1

    potion-effects:
      - BLINDNESS
      - SLOWNESS

  SONIC_BOOM:

    display-name: "Sonic Boom"

    duration-seconds: 8

    amplifier: 1

    potion-effects:
      - DARKNESS
      - WEAKNESS

  THORNS:

    display-name: "Thorns"

    duration-seconds: 6

    amplifier: 0

    potion-effects:
      - WEAKNESS

  CONTACT:

    display-name: "Sharp Contact"

    duration-seconds: 6

    amplifier: 0

    potion-effects:
      - POISON

#
# ============================================================
#                       FALLBACK EFFECT
# ============================================================
#
# Used when no mapped death cause exists.
#
# ============================================================
#

fallback:

  display-name: "Unknown"

  duration-seconds: 5

  amplifier: 0

  potion-effects:
    - WEAKNESS