IMPORTANT: It is highly recommended that if you are upgrading from 6.3.9 or below to a new version of Death Notes, that you move your old DeathNotes.json configuration file elsewhere prior to upgrading to the newest plugin version. Once you restart the updated plugin, it will create a fresh configuration file with death notes that did not exist in previous versions. You may then reincorporate your old messages into the new file. If you do not perform this step, there will be important new death note messages that will be missed

Death Notes allows you to broadcast deaths of different variety to chat, including information like the weapon used and which body part was hit.

Localization

{
  "Distance Unit Singular": "meter",
  "Distance Unit Plural": "meters"
}

Configuration

Messages

The configurable messages consist of these message blocks:

{
    "KillerType": "Player",
    "VictimType": "Player",
    "DamageType": "Bullet",
    "Messages": [
        "{killer} shot {victim} using their {weapon} over a distance of {distance}."
    ]
}

These message blocks can be edited, removed or added to your liking.To disable a message, please just remove the respective message block entirely.The plugin dynamically decides which message should be used in a certain situation.Therefore, you have to specify the KillerType, VictimType and DamageType describing the situation you want your message to appear in.

The message example above is used when a player kills another player doing bullet damage.You can use the default configuration as an example of what it looks like when having multiple message blocks. If adding message blocks, remember to include a comma after the end brace ( }, ).

* and - can also be used for KillerType, VictimType, or DamageType.

• * matches any possible killer/victim/damage type, including a situation with no killer/victim/damage type
• - matches if there is no killer/victim/damage type. This usually only applies to the killer, when one is not applicable or present.

Available Killer/Victim Types

- Helicopter
- Bradley
- Animal
- Murderer
- Scientist
- Player
- Trap
- Turret
- Barricade
- ExternalWall
- HeatSource
- Fire
- Lock
- Sentry
- ScarecrowNPC
- TunnelDweller
- UnderwaterDweller
- ZombieNPC
- GingerbreadNPC
- HeavyScientist
- Minicopter
- AttackHelicopter
- BeeSwarm

Available Damage Types

- Generic 
- Hunger
- Thirst
- Cold
- Drowned
- Heat
- Bleeding
- Poison
- Suicide
- Bullet
- Slash
- Blunt
- Fall
- Radiation
- Bite
- Stab
- Explosion
- RadiationExposure
- ColdExposure
- Decay
- ElectricShock
- Arrow
- Collision

Available Variable Placeholders

Always available:

- {victim} : Name of the victim

Available for deaths involving a killer:

- {killer} : Name of the killer
- {bodypart} : Bodypart which was hit
- {distance} : Distance between killer and victim

Available for deaths involving a Lock, Trap, or Turret as the killer:

- {owner} : Name of the lock/trap/turret owner

Available for deaths involving a Player as the killer:

- {hp} : Remaining HP of the killer
- {weapon} : Weapon used by the killer
- {attachments} : Attachments used on the killers weapon

Miscellaneous configuration settings:

- Chat Format : Configures death note message format.
- Chat Icon (SteamID) : Icon (by Steam ID) to display with death notes.
- Show Kills in Console : Whether or not to print death notes in console.
- Show Kills in Chat : Whether or not to print death notes in game chat.
- Show Patrol Heli Tags : Whether or not to print a message when a player initially hits (tags) the patrol helicopter.
- Show Bradley APC Tags : Whether or not to print a message when a player initially hits (tags) the Bradley APC.
- Patrol Helicopter Tag Message : Message format for patrol helicopter tag messages.
- Bradley Tag Messag : Message format for Bradley APC tag messages.
- Message Broadcast Radius (in meters) : Death notes will only be printed for players within the specified radius, in meters. If set to -1, all players will receive the message regardless of distance.
- Use Metric Distance : Whether or not "distance" values are metric or not.
- Require Permission (deathnotes.cansee) : If enabled, players must have the deathnotes.cansee permission in order to see death notes.

Default Configuration

{
  "Translations": {
    "Death Messages": [
      {
        "KillerType": "Player",
        "VictimType": "Player",
        "DamageType": "Bullet",
        "Messages": [
          "{killer} shot {victim} using their {weapon} over a distance of {distance}."
        ]
      },
      {
        "KillerType": "Player",
        "VictimType": "Player",
        "DamageType": "Arrow",
        "Messages": [
          "{victim} was shot by {killer} with their {weapon} over a distance of {distance}."
        ]
      }
      // More messages here
    ],
    "Names": {
      "Boar": "Boar",
      "Bear": "Bear",
      "Scientist": "Scientist"
      // More enemies here
    },
    "Bodyparts": {
      "Chest": "Chest",
      "Head": "Head",
      "Leg": "Leg"
      // More bodyparts here
    },
    "Weapons": {
      "M249": "M249",
      "Spas-12 Shotgun": "Spas-12 Shotgun",
      "LR-300 Assault Rifle": "LR-300 Assault Rifle"
      // More weapons here
    }
  },
  "Variable Formats": {
    "attachments": " ({value})"
  },
  "Variable Colors": {
    "killer": "#C4FF00",
    "victim": "#C4FF00",
    "weapon": "#C4FF00",
    "attachments": "#C4FF00",
    "distance": "#C4FF00",
    "owner": "#C4FF00"
  },
  "Chat Format": "<color=#838383>[<color=#80D000>DeathNotes</color>] {message}</color>",
  "Chat Icon (SteamID)": "76561198077847390",
  "Show Kills in Console": true,
  "Show Kills in Chat": true,
  "Show Patrol Heli Tags": true,
  "Show Bradley APC Tags": true,
  "Patrol Helicopter Tag Message": "{killer} has tagged the {victim} with their {weapon} over a distance of {distance}.",
  "Bradley Tag Message": "{killer} has tagged the {victim} with their {weapon} over a distance of {distance}.",
  "Message Broadcast Radius (in meters)": -1,
  "Use Metric Distance": true,
  "Require Permission (deathnotes.cansee)": false
}

Permissions

Permissions control the viewing of death notes by players.

- deathnotes.cansee : If Require Permission is set to true in the configuration, then this permission will require that a player has this permission in order to receive death notes.
- deathnotes.suppress: Useful for Admins. Players with this permission will not generate death notes. This permission functions regardless of the Require Permission configuration setting.

For Developers

Hooks

object OnDeathNotice(Dictionary<string, object> data, string message)
// Return false to cancel death message