# 🪦Soul Graves🪦 A unique graves plugin where players collect their souls to retrieve their belongings when they die. A soul will spawn at your death location that provides audio and visual feedback to help you locate it. Once you find it you can retrieve your items by walking into your soul. Be careful though, wait too long and your soul will burst dropping all your items! Special thanks to [Catnies](https://github.com/killertuling) and [ShiroKazane](https://github.com/ShiroKazane) for their contributions to the project! ## Features - Additional Minecraft death mechanics - Fun particle effects - Soul persists through restarts - Visual cue to indicate when the soul is about to burst - Audible heartbeat to make finding your soul easier - Soul Graves will avoid spawning a soul in liquids, the void, and non-solid blocks - Optional hint particles to lead players to their soul - Players can have a customizable number of souls active at the same time - Cross-server support with MySQL + Redis - Option to only let owners retrieve their souls - Option to toggle if souls drop items or xp when they burst - Customizable XP return percentages - Customizable messages with MiniMessage support - Customizable sounds - Custom Event API ## Compatible With - WorldGuard (soul spawning flag) - Vane (soulbound enchantment) - ExcellentEnchants (soulbound enchantment) ## GIFs A stable soul waiting to be collected: ![javaw_YOdJmrwlg5](https://github.com/user-attachments/assets/0131abd3-e1da-4db4-ae97-826624ccee8f) A unstable soul that bursts and drops its contents: ![Animation](https://github.com/user-attachments/assets/8ddf0d00-c7b7-4504-8fff-234f4f7af3dc) ## Configuration

config.yml

```yml # DO NOT EDIT file-version DIRECTLY file-version: 2 # If set true, players will require "soulgraves.spawn" permission to spawn a soul upon death permission-required: false # Time in seconds for how long a soul remains in its stable state before becoming unstable time-stable: 240 # Time in seconds for how long a soul will show the unstable animation for before bursting # The total time the soul is available to collect is time-stable + time-unstable time-unstable: 60 # Whether to freeze the timer when the owner of the soul is offline # This feature cannot detect the online status of players in other subservers on a proxy server offline-owner-timer-freeze: false # Whether to notify nearby players when a soul bursts notify-nearby-players: true # The radius in blocks to alert nearby players when a soul bursts notify-radius: 128 # Whether to notify the owner of a soul when it is collected by another player notify-owner-pickup: true # The percentage of the soul's XP to give to the owner of the soul when it is collected by the owner xp-percentage-owner: 0.5 # The percentage of the soul's XP to give to a player who isn't the owner when the soul is collected by that player xp-percentage-others: 0.2 # The percentage of the soul's XP to drop when the soul bursts xp-percentage-burst: 0.2 # Whether souls are only collectible by their owners owner-locked: false # The maximum number of souls a player can hold simultaneously. Set to 0 for unlimited. # If the limit is exceeded, the oldest soul will explode max-souls-per-player: 0 # Whether souls will drop items when they burst souls-drop-items: true # Whether souls will drop XP when they burst souls-drop-xp: true # What sounds to play when a soul is collected # The format is 'soundEvent, volume, pitch' # The soundKey can be found at https://minecraft.wiki/w/Sounds.json#Java_Edition_values under the 'Sound Event' column pickup-sound: enabled: true sounds: - 'minecraft:block.amethyst_block.break, 1.0, 0.5' - 'minecraft:entity.player.levelup, 1.0, 2.0' - 'minecraft:block.amethyst_block.resonate, 1.0, 0.5' # What sounds to play when a soul bursts # The format is 'soundEvent, volume, pitch' # The soundKey can be found at https://minecraft.wiki/w/Sounds.json#Java_Edition_values under the 'Sound Event' column burst-sound: enabled: true sounds: - 'minecraft:block.glass.break, 3.0, 1.0' - 'minecraft:entity.vex.death, 3.0, 0.5' - 'minecraft:entity.allay.death, 3.0, 0.5' - 'minecraft:entity.warden.sonic_boom, 3.0, 0.5' # What sounds to play to notify nearby players when a soul bursts # The format is 'soundEvent, volume, pitch' # The soundKey can be found at https://minecraft.wiki/w/Sounds.json#Java_Edition_values under the 'Sound Event' column notify-nearby-sound: enabled: true sounds: - 'minecraft:block.amethyst_block.resonate, 1.0, 1.0' # What sounds to play to the owner when their soul bursts # The format is 'soundEvent, volume, pitch' # The soundKey can be found at https://minecraft.wiki/w/Sounds.json#Java_Edition_values under the 'Sound Event' column notify-owner-burst-sound: enabled: true sounds: - 'minecraft:block.amethyst_block.break, 1.0, 0.5' # What sounds to play to the owner when their soul is collected by another player # The format is 'soundEvent, volume, pitch' # The soundKey can be found at https://minecraft.wiki/w/Sounds.json#Java_Edition_values under the 'Sound Event' column notify-owner-pickup-sound: enabled: true sounds: - 'minecraft:block.beacon.deactivate, 1.0, 0.5' # What worlds to disable spawning a soul in # If none, leave a blank array # Usage: #disabled-worlds: # - world_nether # - world_the_end disabled-worlds: [] # Controls particles that will lead the player to their soul hint-particles: enabled: true activation-radius: 128 # The radius around the soul to show hint particles, set to 0 to always show hint particles tracked-soul: 'OLDEST' # Which soul should we track if the player has multiple? Options: OLDEST, NEWEST particle-type: 'END_ROD' start-distance: 5 # How far away from the player the particles should start mode: 'TRAIL' # Options: TRAIL, WANDER trail: length: 8 # How long the particle trail towards the soul should be density: 2 # How many particles to spawn per block distance wander: count: 5 # How many particles should be spawned min-speed: 0.2 # The minimum speed of the particles max-speed: 0.6 # The maximum speed of the particles ```

database.yml

```yml # DO NOT EDIT file-version DIRECTLY file-version: 1 # NOTE: If you change this config, you'll need to restart the server in order for the changes to take effect. # Options: PDC, CROSS_SERVER # If you use CROSS_SERVER, you must set configure both the MySQL and Redis sections storage-mode: PDC # Server name for cross-server storage # Ensure that each server's name is unique when using CROSS_SERVER storage # WARNING: Changing this value after initializing the database will cause data loss server-name: "lobby" # Database config for cross-server storage MySQL: jdbc-url: "jdbc:mysql://localhost:3306/minecraft?useSSL=false&autoReconnect=true" jdbc-class: "com.mysql.cj.jdbc.Driver" properties: user: "root" password: "password" Redis: uri: "redis://localhost:6379/0" ```

messages.yml

```yml # DO NOT EDIT file-version DIRECTLY file-version: 1 # Message to send to the owner when their soul bursts soul-burst: "☠ Your soul has burst!" # Message to send to the owner when their soul bursts and souls-drop-items is true soul-burst-drop-items: "☀ Any belongings inside have been scattered!" # Message to send to the owner when their soul bursts and souls-drop-items is false soul-burst-lose-items: "✖ Any belongings inside have been destroyed!" # Message to send when a soul bursts nearby soul-burst-nearby: "☠ A soul has burst nearby!" # Message to send when a soul is collected soul-collect: "✦ You've collected the soul's contents!" # Message to send to the owner when another player has collected their soul soul-collect-other: "⚑ Someone else has collected your soul!" ```

permissions

```yml soulgraves.command: Allows for the reload and main command soulgraves.spawn: Whether or not a soul grave will spawn for the player ```

## API #### Maven ```xml jitpack.io https://jitpack.io ``` ```xml com.github.FaultyFunctions SoulGraves v{VERSION} ``` #### Gradle ```groovy dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { mavenCentral() maven { url 'https://jitpack.io' } } } ``` ```groovy dependencies { implementation 'com.github.FaultyFunctions:SoulGraves:v{VERSION}' } ``` ## Third-Party Addons - [SoulGravesPlus](https://github.com/JosTheDude/SoulGravesPlus) by [@JosTheDude](https://github.com/JosTheDude) ## Roadmap * [Make a suggestion!](https://github.com/FaultyFunctions/SoulGraves/issues) ## Acknowledgements - [Vanilla Refresh](https://modrinth.com/datapack/vanilla-refresh) - Based on their idea of "Soul Links" - [B's Ghost Graves](https://modrinth.com/plugin/bs-ghostgrave) - Similar plugin inspired by Hollow Knight. They shared their source so I could learn from it, huge thanks! - [MorePersistentDataTypes](https://github.com/mfnalex/MorePersistentDataTypes) - Great PDC library - [BoostedYAML](https://github.com/dejvokep/boosted-yaml) - YAML configuration library

Faulty

Faulty

Whimscape x EMI