# Death Notes
**Death Notes** is a Rust plugin that broadcasts deaths with a sleek GUI kill feed. It provides detailed information about PvP, PvE, and environmental deaths, including weapon types, distances, and kill streaks.
## Features
- **GUI Kill Feed:** Displays death notices in a customizable UI overlay rather than just chat.
- **Kill Streaks:** Tracks player kill streaks and records the best streaks on the server.
- **Detailed Combat Info:** Displays distance, weapon used, and specific icons for headshots or explosions.
- **Revenge System:** Detects and flags "Revenge" kills when a player kills their previous killer.
- **Advanced Tracking:** Supports specific death types including flamethrowers, fireballs, and bleeding.
- **Categorized Styling:** Different background colors for PvP, PvE, Environmental, and Special deaths.
---
## Permissions
This plugin uses the following permissions to control visibility:
- `deathnotes.cansee` - Allows a player to see the kill feed (required if `Require Permission` is enabled in config).
- `deathnotes.cantsee` - Prevents a player from seeing the kill feed.
- `deathnotes.suppress` - Can be used to suppress death messages for specific players.
---
## Commands
### Chat Commands
- `/streak` - Displays your current and best kill streak.
- `/topstreaks` - Displays the top 5 kill streaks currently recorded on the server.
### Console Commands
- `deathnotes.test` - Adds a test entry to the kill feed to verify UI positioning and styling.
---
## Configuration
The configuration file allows you to modify UI positioning, colors, timeouts, and tracking settings.
### Default Configuration
```json
{
"UI Settings": {
"Anchor Min (screen position)": "0.0 0.65",
"Anchor Max (screen position)": "0.3 0.95",
"Background Color": "0 0 0 0",
"Entry Background Color": "0.1 0.1 0.1 0.85",
"Entry Background Color (PvP)": "0.6 0.1 0.1 0.75",
"Entry Background Color (PvE)": "0.1 0.4 0.1 0.75",
"Entry Background Color (Death)": "0.3 0.1 0.1 0.75",
"Entry Background Color (Special)": "0.5 0.3 0.0 0.85"
},
"Kill Feed Settings": {
"Max Entries Shown": 5,
"Entry Display Time (seconds)": 6.0,
"Show Distance": true,
"Show Weapon": true,
"Show Headshot Icon": true,
"Show Kill Streak": true,
"Show Revenge": true,
"Use Metric Distance": true,
"PvP Only Mode": false,
"Show in Chat Too": false,
"Show in Console": true
},
"Kill Streak Settings": {
"Enabled": true,
"Timeout (seconds)": 120.0,
"Milestones": [3, 5, 7, 10, 15, 20],
"Min Streak to Show": 3,
"Announce Streak End (min kills)": 5
},
"General Settings": {
"Message Radius (-1 for global)": -1,
"Require Permission": false,
"Debug Mode": false
}
}