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:

{
    "Display Permissions (Display For All Players If Empty)": [],
    "KillerType": "Player",
    "VictimType": "Player",
    "DamageType": "Bullet",
    "Enabled": true,
    "Show Kills in Console": true,
    "Show Kills in Chat": true,
    "Show Kills in Notify": false,
    "Show Kills in UINotify": false,
    "Messages": [
        "{killer} shot {victim} using their {weapon} over a distance of {distance}."
    ]
}

These message blocks can be added or edited to your liking.To disable a message, please change Enabled to false.The setting Display Permissions (Display For All Players If Empty) allows the creation of custom permissions (must start with "deathnotes.") for groups of players to see certain death messages.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. Please note that you may only have one block of settings for any particular set of KillerType, VictimType and DamageType combination.

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
- SAM
- Shark
- NPCShopKeeper
- ExcavatorArm
- Drone
- CarShredder
- Cactus
- Train
- MagnetCrane
- Elevator
- HotAirBalloon
- BatteringRam
- Tugboat
- CargoShip
- CustomNPC

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
- {position} : The world position of the death event in (X,Y,Z) format
- {mapgrid} : The map grid position of the death event

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, Turret, or SAM Site 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.
- Debug Mode Enabled : Whether or not to print debug messages in the Death Notes log files.
- Notify Message Type : Message type (see Notify plugin configuration) for Death Notes output.
- UINotify Message Type : Message type (see UINotify plugin configuration) for Death Notes output.
- Can Player Use /dn Command : Whether or not a player can use the /dn chat command to alter their settings.
- Patrol Heli Tags Display Permissions (Display For All Players If Empty) : Custom permissions for players who can see patrol helicopter tag messages.
- Show Patrol Heli Tags in Console : Whether or not to print a message to console when a player initially hits (tags) the patrol helicopter.
- Show Patrol Heli Tags in Chat : Whether or not to print a message to chat when a player initially hits (tags) the patrol helicopter.
- Show Patrol Heli Tags in Notify : Whether or not to print a message to Notify plugin when a player initially hits (tags) the patrol helicopter.
- Show Patrol Heli Tags in UINotify : Whether or not to print a message to UINotify plugin when a player initially hits (tags) the patrol helicopter.
- Patrol Helicopter Tag Message : Message format for patrol helicopter tag messages.
- Bradley APC Tags Display Permissions (Display For All Players If Empty) : Custom permissions for players who can see Bradley APC tag messages.
- Show Bradley APC Tags in Console : Whether or not to print a message to console when a player initially hits (tags) the Bradley APC.
- Show Bradley APC Tags in Chat : Whether or not to print a message to chat when a player initially hits (tags) the Bradley APC.
- Show Bradley APC Tags in Notify : Whether or not to print a message to Notify plugin when a player initially hits (tags) the Bradley APC.
- Show Bradley APC Tags in UINotify : Whether or not to print a message to UINotify plugin when a player initially hits (tags) the Bradley APC.
- Bradley Tag Message : 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": [
      {
        "Display Permissions (Display For All Players If Empty)": [],
        "KillerType": "Player",
        "VictimType": "Player",
        "DamageType": "Bullet",
        "Enabled": true,
        "Show Kills in Console": true,
        "Show Kills in Chat": true,
        "Show Kills in Notify": false,
        "Show Kills in UINotify": false,
        "Messages": [
          "{killer} shot {victim} using their {weapon} over a distance of {distance}."
        ]
      },
      {
        "Display Permissions (Display For All Players If Empty)": [],
        "KillerType": "Player",
        "VictimType": "Player",
        "DamageType": "Arrow",
        "Enabled": true,
        "Show Kills in Console": true,
        "Show Kills in Chat": true,
        "Show Kills in Notify": false,
        "Show Kills in UINotify": false,
        "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",
    "position": "#C4FF00",
    "mapgrid": "#C4FF00"
  },
  "Chat Format": "<color=#838383>[<color=#80D000>DeathNotes</color>] {message}</color>",
  "Chat Icon (SteamID)": "76561198077847390",
  "Debug Mode Enabled": false,
  "Notify Message Type": 0,
  "UINotify Message Type": 0,
  "Can Player Use /dn Command": true,
  "Patrol Heli Tags Display Permissions (Display For All Players If Empty)": [],
  "Show Patrol Heli Tags in Console": true,
  "Show Patrol Heli Tags in Chat": true,
  "Show Patrol Heli Tags in Notify": false,
  "Show Patrol Heli Tags in UINotify": false,
  "Patrol Helicopter Tag Message": "{killer} has tagged the {victim} with their {weapon} over a distance of {distance}.",
  "Bradley APC Tags Display Permissions (Display For All Players If Empty)": [],
  "Show Bradley APC Tags in Console": true,
  "Show Bradley APC Tags in Chat": true,
  "Show Bradley APC Tags in Notify": false,
  "Show Bradley APC Tags in UINotify": false,
  "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.cantsee : Prevents a player or group with this permission from seeing any Death Notes output. This permission functions regardless of the Require Permission configuration setting.
- deathnotes.suppress: Useful for Admins. Players with this permission will not generate death notes. This permission functions regardless of the Require Permission configuration setting.
- deathnotes.seeteamonly: Prevents a player or group with this permission from seeing any Death Notes output other than those pertaining to them or their teammates.
NOTE: Custom permissions can also be used per death message setting block. Permissions must begin with "deathnotes." and cannot be identically named as the above default permissions.

Commands

Chat commands that players can use to modify Death Notes visibility.

- /dn - Toggles the player's ability to see Death Notes output.
- /dn teamonly - Toggles the player's ability to see Death Notes output for their team only.

For Developers

Hooks

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