RUST Death Notes Plugin (How to Install, Configure & Use)

RUST Death Notes Plugin

What is the Death Notes plugin?

Death Notes (DN) is a RUST plugin that broadcasts and displays details of all player deaths to the global server chat. It is patched and supported by Mevent and is a free-to-use plugin available for download on uMod. The plugin is seen on modded and community servers that wish to showcase player deaths to the masses.

Potential reasons to use the Death Notes plugin

Death Notes has grown in popularity in recent years, particularly on PVP-heavy servers. It allows for customizable readout messages to be displayed in chat during a player’s (or NPC’s) death. DN is completely alterable from the top down, allowing server owners to put their flare into the readouts, allowing for a fully customized feel and experience. This plugin also helps show activity across a server, which may be very beneficial if your population is low and you want to ensure people see some pulse of life.

RUST Death Notes Example

Installing the Death Notes plugin

As with all uMod plugins, the server you intend to install them on requires uMod (Oxide) to be installed to facilitate their function. For a step-by-step perspective on how to install this plugin, please reference the following list:

  1. First, you must have uMod/Oxide installed on your server. Use our Installing uMod (Oxide) on Your RUST server guide if you need help; otherwise, if you use a third-party hosting, their user interface will have instructions on how to get started. It may be tooled explicitly to their platform, so reach out to your host for details.
  2. Acquire the latest version of the plugin from uMod’s Death Notes page, or download the CS file directly.
  3. Locate the downloaded DeathNotes.cs file and install the plugin on your RUST server, or follow your host-specific instructions.
  4. Once you’ve installed Death Notes in the plugins folder, and if the server is actively running, uMod will immediately create an alternate DeathNotes.json file in your config folder. You will make all configuration changes to the .json file in the config folder.

Permissions

Death Notes requires no oxide-specific permissions other than administrative access to the config system files located on your server under Oxide > config > DeathNotes.json.

Additional dependencies

Like many other uMod plugins, Death Notes may work as a standalone mod or in conjunction with other select mods. A full list of such mods includes:

Activation steps

Once installed, the server will automatically use the preassigned configuration functions to display chat readouts following the current settings.

Recommended plugin configurations

By default, the configuration of the DeathNotes.json file should be adequate for most server owners’ purposes. To better understand potential option changes, this guide will go through the configuration file line by line as it pertains to the most commonly changed settings.

This is an example configuration file for Death Notes – It has been altered slightly to explain setting change impact better – DO NOT copy and paste this example into your configuration.

{
  "Translations": {
 "Death Messages": [
   {
     "KillerType": "Player",
     "VictimType": "Player",
     "DamageType": "Bullet",
     "Messages": [
       "{killer} shot {victim} in the {bodypart} using a {weapon} over {distance}" - customizable chat readout for deaths involving players shooting other players.
     ]
   },
   {
     "KillerType": "Player",
     "VictimType": "Player",
     "DamageType": "Arrow",
     "Messages": [
       "{killer} pelted {victim} in their {bodypart} with a {weapon} over a distance of {distance}." - customizable chat readout for deaths involving players killing other players with arrows OR thrown spears.
     ]
   },
   {
     "KillerType": "Player",
     "VictimType": "Player",
     "DamageType": "Heat",
     "Messages": [
       "{killer} caught {victim} on fire with their {weapon}." - customizable chat readout for deaths involving players burning other players to death.
     ]
   },
   {
     "KillerType": "Player",
     "VictimType": "Player",
     "DamageType": "*",
     "Messages": [
       "{killer} mutilated {victim} using a {weapon} from {distance} away." - customizable chat readout for deaths involving players killing players with non-defined weapon types.
     ]
   },
   {
     "KillerType": "Trap",
     "VictimType": "Player",
     "DamageType": "*",
     "Messages": [
       "{victim} died to a trap." - customizable chat readout for deaths involving players dying to assorted traps / turrets.
     ]
   },
   {
     "KillerType": "Sentry",
     "VictimType": "Player",
     "DamageType": "*",
     "Messages": [
       "{victim} did something stupid in a safezone and was killed by a {killer}." - customizable chat readout for deaths involving players dying in safe zones.
     ]
   },
   {
     "KillerType": "HeatSource",
     "VictimType": "Player",
     "DamageType": "*",
     "Messages": [
       "{victim} was grilled on a {killer}." - customizable chat readout for deaths involving players burning to death (Campfire / Bradley Fire).
     ]
   },
   {
     "KillerType": "*",
     "VictimType": "Player",
     "DamageType": "Heat",
     "Messages": [
       "{victim} burned to death." - customizable chat readout for deaths involving players burning to death (Molotov / Flame Thrower).
     ]
   },
   {
     "KillerType": "Player",
     "VictimType": "Player",
     "DamageType": "Suicide",
     "Messages": [
"{victim} F1 killed." - usually left blank, can spam chat if turned on.
]
   },
   {
     "KillerType": "*",
     "VictimType": "Player",
     "DamageType": "Radiation",
     "Messages": [
       "{victim} died to radiation." - customizable chat readout for deaths involving radiation
     ]
   },
   {
     "KillerType": "*",
     "VictimType": "Player",
     "DamageType": "Cold",
     "Messages": [
       "{victim} froze to death." - customizable chat readout for deaths as a result of freezing
     ]
   },
   {
     "KillerType": "*",
     "VictimType": "Player",
     "DamageType": "Drowned",
     "Messages": [
       "{victim} drowned." - customizable chat readout for deaths involving drowning
     ]
   },
   {
     "KillerType": "Player",
     "VictimType": "Player",
     "DamageType": "Bleeding",
     "Messages": [
       "{victim} bled out after being attacked by {killer}." - customizable chat readout for deaths as a result of bleeding out
     ]
   },
   {
     "KillerType": "Player",
     "VictimType": "Animal",
     "DamageType": "Collision",
     "Messages": [
       "{killer} ran over a poor defenseless {victim}." - customizable chat readout for animal deaths involving vehicle types
     ]
   },
   {
     "KillerType": "Player",
     "VictimType": "Player",
     "DamageType": "Collision",
     "Messages": [
       "{killer} ran over {victim}." - customizable chat readout for player deaths involving vehicle types
     ]
   }
 ],
 "Names": {
   "Bear Trap": "Bear Trap",
   "Gun Trap": "Gun Trap",
   "Boar": "Boar",
   "Chicken": "Chicken",
   "Sentry": "Sentry",
   "Fire": "Fire",
   "Wolf": "Wolf",
   "Landmine": "Landmine",
   "Flame Turret": "Flame Turret",
   "Helicopter": "Helicopter",
   "Sam Site": "Sam Site",
   "Stag": "Stag",
   "Campfire": "Campfire",
   "Bear": "Bear",
   "Base Oven": "Base Oven",
   "Tesla Coil": "Tesla Coil",
   "Polarbear": "Polarbear",
 },
 "Bodyparts": { - Altering the second variable allows for customized bodypart readout information.
   "Body": "Body",
   "Hand": "Hand",
   "Arm": "Arm",
   "Head": "Head",
   "Chest": "Chest",
   "Leg": "Leg",
   "Stomach": "belly", - this config would read 'belly' instead of stomach
   "Foot": "Foot"
 },
 "Weapons": {  - Altering the second variable allows for customized weapon type readout information.
   "L96 Rifle": "L96",  - this configuration would say L96 instead of L96 Rifle
   "Salvaged Sword": "Salvaged Sword",
   "Assault Rifle": "Assault Rifle",
   "Vehicle": "Vehicle",
   "Machete": "Machete",
   "Combat Knife": "Combat Knife",
   "MP5A4": "MP5A4",
   "Pump Shotgun": "Pump Shotgun",
   "Stone Pickaxe": "Stone Pickaxe",
   "M249": "M249",
   "Thompson": "Thompson",
   "Spas-12 Shotgun": "Spas-12 Shotgun",
   "LR-300 Assault Rifle": "LR-300 Assault Rifle",
   "Custom SMG": "Custom SMG",
   "Bolt Action Rifle": "Bolt Action Rifle",
   "Rock": "Rock",
   "Torch": "Torch",
   "Timed Explosive Charge": "Timed Explosive Charge",
   "Rocket": "Rocket",
   "F1 Grenade": "F1 Grenade",
   "Wooden Spear": "Wooden Spear",
   "M39 Rifle": "M39 Rifle",
   "Python Revolver": "Python Revolver",
   "Jackhammer": "Jackhammer",
   "M92 Pistol": "M92 Pistol",
   "Semi-Automatic Rifle": "Semi-Automatic Rifle",
   "Satchel Charge": "Satchel Charge",
   "Stone Hatchet": "Stone Hatchet",
   "Hunting Bow": "Hunting Bow",
   "rocket_mlrs": "rocket_mlrs",
   "lr300.entity": "lr300.entity",
   "Hatchet": "Hatchet",
   "Flame Thrower": "Flame Thrower",
   "Paddle": "Paddle",
   "High Velocity Rocket": "High Velocity Rocket",
   "Salvaged Cleaver": "Salvaged Cleaver",
   "Bone Knife": "Bone Knife",
   "Crossbow": "Crossbow",
   "Eoka Pistol": "Eoka Pistol",
   "Revolver": "Revolver",
   "Pickaxe": "Pickaxe",
   "Waterpipe Shotgun": "Waterpipe Shotgun",
   "Semi-Automatic Pistol": "Semi-Automatic Pistol",
   "Birthday Cake": "Birthday Cake",
   "Double Barrel Shotgun": "Double Barrel Shotgun",
   "knife.combat.entity": "knife.combat.entity",
   "skull.entity": "skull.entity",
   "Mace": "Mace",
   "Longsword": "Longsword",
   "Compound Bow": "Compound Bow",
   "Skull": "Skull",
   "Salvaged Axe": "Salvaged Axe",
   "Beancan Grenade": "Beancan Grenade",
   "40mm_grenade_he": "40mm_grenade_he",
   "Snowball Gun": "Snowball Gun",
   "Candy Cane Club": "Candy Cane Club",
   "Nailgun": "Nailgun",
   "Chainsaw": "Chainsaw",
   "Stone Spear": "Stone Spear",
   "Snowball": "Snowball",
   "Multiple Grenade Launcher": "Multiple Grenade Launcher",
   "Salvaged Hammer": "Salvaged Hammer",
   "pickaxe.entity": "pickaxe.entity",
   "smg.entity": "smg.entity",
   "hatchet.entity": "hatchet.entity",
   "paddle.entity": "paddle.entity",
   "bolt_rifle.entity": "bolt_rifle.entity",
   "Flashlight": "Flashlight",
   "Salvaged Icepick": "Salvaged Icepick",
   "Incendiary Rocket": "Incendiary Rocket",
   "shotgun_waterpipe.entity": "shotgun_waterpipe.entity",
   "axe_salvaged.entity": "axe_salvaged.entity",
   "mp5.entity": "mp5.entity",
   "torch.entity": "torch.entity",
   "ak47u.entity": "ak47u.entity",
   "Assault Rifle - ICE": "Assault Rifle - ICE",
   "double_shotgun.entity": "double_shotgun.entity",
   "watergun.entity": "watergun.entity",
   "crossbow.entity": "crossbow.entity",
   "icepick_salvaged.entity": "icepick_salvaged.entity",
   "shotgun_pump.entity": "shotgun_pump.entity",
   "stone_pickaxe.entity": "stone_pickaxe.entity",
   "HMLMG": "HMLMG",
   "workcart_aboveground2.entity": "workcart_aboveground2.entity",
   "3module_car_spawned.entity": "3module_car_spawned.entity",
   "2module_car_spawned.entity": "2module_car_spawned.entity",
   "workcart_aboveground.entity": "workcart_aboveground.entity",
   "4module_car_spawned.entity": "4module_car_spawned.entity",
   "Bone Club": "Bone Club",
   "waterpistol.entity": "waterpistol.entity",
   "snowmobile": "snowmobile",
   "stonehatchet.entity": "stonehatchet.entity",
   "locomotive.entity": "locomotive.entity",
   "grenade.molotov.deployed": "grenade.molotov.deployed",
   "grenade.flashbang.deployed": "grenade.flashbang.deployed",
   "hammer_salvaged.entity": "hammer_salvaged.entity"
 },
 "Attachments": {  - Altering the second variable allows for customized attachment readout information (where applicable).
   "16x Zoom Scope": "16x Zoom Scope",
   "Weapon Lasersight": "Weapon Lasersight",
   "Weapon flashlight": "Weapon flashlight",
   "Holosight": "Holosight",
   "Silencer": "Silencer",
   "8x Zoom Scope": "8x Zoom Scope",
   "Muzzle Boost": "Muzzle Boost",
   "Simple Handmade Sight": "Simple Handmade Sight",
   "Muzzle Brake": "Muzzle Brake",
   "Extended Magazine": "Extended Magazine"
 }
  },
  "Variable Formats": {
  },
  "Variable Formats": {
 "attachments": " ({value})"
  "Variable Colors": { - Altering these variables changes the color displayed in game chat per type, using Hex Codes
 "killer": "#FFFFFF",
 "victim": "#FFFFFF",
 "weapon": "#FFFFFF",
 "attachments": "#FFFFFF",
 "distance": "#FFFFFF",
 "owner": "#FFFFFF"
  },
  "Chat Format": "<color=#FFFFFF>[<color=#80D000>Custom Name of Your Server Here</color>] {message}</color>",
  "Chat Icon (SteamID)": "17 digit steam ID here", - The ingame icon is static unless this variable is altered to a steam ID. When a new steam ID is entered, the profile picture of that steam ID, whatever it is set to, will instead appear as the ingame icon for all Deathnotes Readouts
  "Show Kills in Console": true,  - toggle false to receive less console spam
  "Show Kills in Chat": true,  - toggle false to disable deathnote chat readouts
  "Message Broadcast Radius (in meters)": -1,
  "Use Metric Distance": true,
  "Require Permission (deathnotes.cansee)": false
}

Variable placeholders within the configuration

Within the config file itself, players may use the following variables for customization of chat readout messages:

VariableDescription
{victim}Name of the killed player/NPC
{killer}Name of killing entity/player
{bodypart}The portion of the body that delivered the final hit
{distance}Meters between killer and victim

Deaths involving a Lock, Trap, or Turret as the killer may include:

VariableDescription
{owner}The ID of the lock/trap/turret placer

Deaths involving a steam player as the killer:

VariableDescription
{weapon}The weapon used to deliver the killing blow
{attachments} Attachments used on the killing weapon
{hp}Health remaining of the killer at the time of the murder

How to update the Death Notes plugin

Updating the RUST Death Notes plugin is simple and quick.

  1. Visit the uMod Death Notes plugin page
  2. Download the latest version of the Death Notes plugin
  3. Overwrite the existing DeathNotes.cs file in your Oxide plugins folder.

It is best practice not to uninstall the mod, as you do not need to alter the JSON file. It will remain with your existing settings (unless the developer otherwise suggests a complete reinstall).

How to remove the Death Notes plugin

As the Death Notes plugin doesn’t impact player experience or game features necessary to run processes in the game itself, removing the plugin is as simple as deleting DeathNotes.cs from your plugins folder.

A more thorough approach for removing Death Notes is to:

  1. Prepare and properly shut down the RUST server
  2. Open the Oxide plugins folder in your server directory
  3. Locate and delete the DeathNotes.cs file
  4. Open the Oxide config folder in your server directory
  5. Locate and delete the DeathNotes.json configuration file
  6. Restart the RUST server

Suppose you want to disable the Death Notes plugin for a short period. You can use the oxide.unload DeathNotes command, which you may also run in the F1 console, RCON, or Web Console. 

Disclaimer and seeking assistance

Corrosion Hour does not maintain the RUST Death Notes plugin, nor do we assist with modifying the plugin outside the config scope. Visit the plugin’s uMod page to support the plugin creators, report bugs, or propose feature requests. Please get in touch with an admin in our Discord community for help with the steps and instructions in this guide.

Tempest Hosting
No Limit Llama's avatar

About No Limit Llama

An aspiring woodworker and web designer. Father, husband, and Rust veteran. Llama has written op-eds and official game documents for over two decades. The earliest writings were on Asheron’s Call, followed by World of Warcraft and eventually Rust. The vast majority of his indoor time is spent running Rust servers or helping friends with their Rust-related projects. He enjoys working around the house, continuing his education when time permits, and creating new processes to simplify activities of daily living for his friends and family. He has an incredible wife, a dog, three children, and one granddaughter.

View all posts by No Limit Llama →