KillSounds Plugin - Documentation

ShyamSai · Sunday at 11:21 AM

Introduction

KillSounds is a premium Minecraft plugin that enhances the PvP experience on your server by allowing players to select custom sounds that play when they eliminate another player. This plugin adds an exciting audio dimension to combat that players will love and can be used as a monetization opportunity through sound permissions.

KillSounds features an intuitive GUI for sound selection, permission-based sound options, PlaceholderAPI support, and optimized asynchronous data handling to ensure smooth performance even on busy servers.

Product Link: https://builtbybit.com/resources/killsounds-customizable-pvp-kill-sound.63504/

Installation

Requirements

Minecraft server running Paper/Spigot 1.20 or higher
(Optional) PlaceholderAPI for placeholder support

Installation Steps

Download the KillSounds plugin JAR file
Place the JAR file in your server's plugins folder
Restart your server or load the plugin using a plugin manager
The plugin will generate default configuration files
(Optional) Install PlaceholderAPI if you wish to use placeholders

Commands

KillSounds provides the following commands:

Command	Alias	Description	Permission
/killsounds	/ks	Opens the kill sound selector GUI	killsounds.use
/uksounds reload	/uks reload	Reloads the plugin configuration	killsounds.admin

Permissions

KillSounds uses a permission-based system that allows you to restrict certain sounds to specific players or groups:

Core Permissions

Permission	Description	Default
killsounds.use	Allows access to the kill sounds selector	true
killsounds.admin	Allows access to admin commands	op

Sound Permissions

Permission	Description	Default
killsounds.sound.meow	Allows use of the meow kill sound	true
killsounds.sound.grunt	Allows use of the grunt kill sound	true
killsounds.sound.splash	Allows use of the splash kill sound	true
killsounds.sound.roar	Allows use of the roar kill sound	true
killsounds.sound.growl	Allows use of the growl kill sound	true
killsounds.sound.slime	Allows use of the slime kill sound	true
killsounds.sound.donkey	Allows use of the donkey kill sound	true
killsounds.sound.howl	Allows use of the howl kill sound	true
killsounds.sound.moo	Allows use of the moo kill sound	true
killsounds.sound.bat	Allows use of the bat kill sound	true
killsounds.sound.zombie	Allows use of the zombie kill sound	true
killsounds.sound.skeleton	Allows use of the skeleton kill sound	true
killsounds.sound.sneeze	Allows use of the sneeze kill sound	true
killsounds.sound.anvil	Allows use of the anvil kill sound	true
killsounds.sound.beacon	Allows use of the beacon kill sound	true
killsounds.sound.teleport	Allows use of the teleport kill sound	true

Configuration

KillSounds is highly configurable through the config.yml file. Here's a breakdown of the configuration options:

Code:

# KillSounds Configuration

# How far away players can hear kill sounds (in blocks)
sound-distance: 30

# Volume of kill sounds (0.0 to 1.0)
sound-volume: 1.0

# Pitch of kill sounds (0.5 to 2.0)
sound-pitch: 1.0

# Whether to play sounds to the killer
play-to-killer: true

# Whether to play sounds to the victim
play-to-victim: true

# Custom sound options (you can add your own)
custom-sounds:
  # Example of a custom sound:
  # dragon:
  #   sound: ENTITY_ENDER_DRAGON_GROWL
  #   permission: killsounds.sound.dragon

# GUI settings
gui:
  # Title of the GUI
  title: "Kill sound selector"

  # Colors
  selected-color: "&#08FB1F"  # Lime color for selected items
  unselected-color: "&#FF0000"  # Red color for unselected items

# Messages
messages:
  no-permission: "&c✘ You don't have permission to use this command."
  sound-selected: "&a&l✓ &aKill sound set to &e%sound%&a."
  sound-disabled: "&a&l✓ &aKill sounds have been disabled."
  reload-success: "&a&l✓ &aKillSounds plugin reloaded successfully."

Adding Custom Sounds

To add a custom sound, uncomment and modify the example in the custom-sounds section:

Code:

custom-sounds:
  dragon:
    sound: ENTITY_ENDER_DRAGON_GROWL
    permission: killsounds.sound.dragon
  thunder:
    sound: ENTITY_LIGHTNING_BOLT_THUNDER
    permission: killsounds.sound.thunder

The sound value must be a valid Minecraft sound name from the Bukkit Sound Enum.

Features

Sound Selection GUI

KillSounds provides an intuitive GUI for players to select their kill sound:

The GUI shows all available sounds that the player has permission to use
The currently selected sound is highlighted in lime green
Unavailable sounds (no permission) are not displayed
"None" option is always available to disable kill sounds

Kill Detection System

KillSounds features an advanced kill detection system that:

Correctly attributes kills in both direct and indirect PvP scenarios
Tracks damage over time to properly assign kill credit
Works with various combat plugins and vanilla combat mechanics

Data Storage

Player sound preferences are stored in JSON files:

One file per player stored in the plugins/KillSounds/data/ directory
Files are named using player UUID (e.g., 123e4567-e89b-12d3-a456-426614174000.json)
Data is loaded asynchronously on plugin start and player login
Data is saved asynchronously when a player selects a sound or logs out
During server shutdown, data is saved synchronously to ensure no data loss

Performance Considerations

KillSounds is designed with performance in mind:

Asynchronous data loading and saving
Efficient event handling
Low memory footprint
Minimal impact on server TPS

PlaceholderAPI Integration

KillSounds integrates with PlaceholderAPI to provide placeholders for use in other plugins.

Available Placeholders

Placeholder	Description	Example Output
%killsounds_selected%	Shows the player's currently selected kill sound	"Zombie", "Roar", "None"

Usage Examples

Display in chat: Your current kill sound is: %killsounds_selected%
On scoreboards: Selected: %killsounds_selected%
In GUIs of other plugins that support PlaceholderAPI

Frequently Asked Questions

Q: How do I add new sounds?

A: To add custom sounds, edit the custom-sounds section in the config.yml file. You'll need to specify a sound name and the corresponding Bukkit Sound enum value.

Q: How can I make certain sounds VIP-only?

A: Set the default permission to false in your permissions plugin for specific sound permissions (e.g., killsounds.sound.dragon: false), then grant that permission only to your VIP ranks.

Q: Can I change the GUI appearance?

A: Yes, you can modify the GUI title and colors in the config.yml file under the gui section.

Q: Do kill sounds play for all deaths or just PvP?

A: Kill sounds only play for PvP kills (player kills player), not for deaths by mobs, fall damage, etc.

Q: How far can players hear kill sounds?

A: By default, kill sounds can be heard within a 30-block radius. You can adjust this in the config.yml with the sound-distance setting.

Troubleshooting

Kill sounds aren't playing

Ensure the player has selected a sound other than "None"
Check if the sound distance in config.yml is set appropriately
Verify that the player has permission for the selected sound
Make sure the killer and victim are both in the same world

Plugin fails to load

Check the server console for error messages
Ensure you're using a supported server version (1.16+)
Verify the plugin JAR file is not corrupted

Data isn't saving

Check server permissions for writing to the plugins/KillSounds directory
Ensure the server has sufficient disk space
Look for error messages in the server logs

PlaceholderAPI placeholders aren't working

Verify that PlaceholderAPI is installed and up to date
Check if KillSounds properly registered with PlaceholderAPI (look for a message in console during startup)
Make sure you're using the correct placeholder syntax

Search

Welcome!

KillSounds Plugin - Documentation

ShyamSai

𝐀𝐝𝐦𝐢𝐧𝐢𝐬𝐭𝐫𝐚𝐭𝐨𝐫𝐬

Introduction

Installation

Requirements

Installation Steps

Commands

Permissions

Core Permissions

Sound Permissions

Configuration

Adding Custom Sounds

Features

Sound Selection GUI

Kill Detection System

Data Storage

Performance Considerations

PlaceholderAPI Integration

Available Placeholders

Usage Examples

Frequently Asked Questions

Q: How do I add new sounds?

Q: How can I make certain sounds VIP-only?

Q: Can I change the GUI appearance?

Q: Do kill sounds play for all deaths or just PvP?

Q: How far can players hear kill sounds?

Troubleshooting

Kill sounds aren't playing

Plugin fails to load

Data isn't saving

PlaceholderAPI placeholders aren't working

Welcome!

KillSounds Plugin - Documentation

ShyamSai

𝐀𝐝𝐦𝐢𝐧𝐢𝐬𝐭𝐫𝐚𝐭𝐨𝐫𝐬

​

Introduction​

Installation​

Requirements​

Installation Steps​

Commands​

Permissions​

Core Permissions​

Sound Permissions​

Configuration​

Adding Custom Sounds​

Features​

Sound Selection GUI​

Kill Detection System​

Data Storage​

Performance Considerations​

PlaceholderAPI Integration​

Available Placeholders​

Usage Examples​

Frequently Asked Questions​

Q: How do I add new sounds?​

Q: How can I make certain sounds VIP-only?​

Q: Can I change the GUI appearance?​

Q: Do kill sounds play for all deaths or just PvP?​

Q: How far can players hear kill sounds?​

Troubleshooting​

Kill sounds aren't playing​

Plugin fails to load​

Data isn't saving​

PlaceholderAPI placeholders aren't working​

Introduction

Installation

Requirements

Installation Steps

Commands

Permissions

Core Permissions

Sound Permissions

Configuration

Adding Custom Sounds

Features

Sound Selection GUI

Kill Detection System

Data Storage

Performance Considerations

PlaceholderAPI Integration

Available Placeholders

Usage Examples

Frequently Asked Questions

Q: How do I add new sounds?

Q: How can I make certain sounds VIP-only?

Q: Can I change the GUI appearance?

Q: Do kill sounds play for all deaths or just PvP?

Q: How far can players hear kill sounds?

Troubleshooting

Kill sounds aren't playing

Plugin fails to load

Data isn't saving

PlaceholderAPI placeholders aren't working