SoulBond Hardcore Plugin Documentation
Overview
The
SoulBond Hardcore Plugin is a feature-rich hardcore experience for Spigot Minecraft servers. It adds multiple lives, a ghost system, clan mechanics, and several unique ways to revive players. It is designed for a deeper and more challenging hardcore gameplay experience.
Version: 1.1
Author: Safal Bhurtel
Minecraft Version: 1.20+
Supported Servers: Spigot, Paper
Features
1. Player Lifecycle System
- Multiple Lives: Each player starts with a configurable number of lives (default: 3).
- Death Penalties: When a player dies, they lose one life. Upon losing all lives, they enter Ghost Mode (spectator mode).
- Custom Death Messages: Server-wide announcements are broadcast whenever a player dies. These messages are customizable in the configuration file.
2. Ghost System
- Ghost Mode: Players who run out of lives become ghosts, which puts them into spectator mode.
- Interaction: Ghosts can observe the world but cannot interact with it.
- Ghost Chat: Ghosts can communicate with living players. This behavior is configurable.
- Revival: Ghosts can be revived through specific revival methods detailed below.
3. Revival System
Players can be revived through different methods:
- Heart Sacrifice: A living player can sacrifice part of their health to revive a dead player using the /revive <player> command.
- Sacrifices 1 or more hearts (configurable).
- Revived players come back with 1 life.
- Soul Revival Totem: A rare item that automatically revives a player when used (can be placed in inventory).
- Crafted with diamonds, gold blocks, and emerald blocks.
- Consumed upon use.
- Book of Revival: A mystical item that revives a player with minimal sacrifice.
- Crafted with lapis blocks, experience bottles, and books.
- Consumes 1 heart from the current health of the player (not max health).
4. Life Essence
- Life Essence: A consumable item that grants an extra life to the player.
- Crafted using ghast tears, redstone blocks, and golden apples.
- Use via right-click to gain 1 extra life.
- Configurable maximum number of lives in config.yml.
5. Soul-Bound Items
- Soul Binding: Allows players to bind items to their soul so they stay in their inventory even after death.
- Use the Book of Soul Binding to bind an item to the player's soul.
- Maximum number of soul-bound items is configurable in config.yml.
- Crafted using soul sand, ender pearls, and books.
6. Soul Power System
- Gaining Soul Power: Players can earn Soul Power by:
- Killing players (+1 Soul Power)
- Surviving for 3+ hours (+1 Soul Power)
- Winning PvP fights without dying (+1 Soul Power)
Soul Power Benefits:
- Level 3: +1 Max Heart
- Level 5: Speed I Buff
- Level 10: Permanent Strength I
- Level 15: Extra 20% XP from kills
Note: Soul Power is reset upon death.
7. Clan Soul-Link System
- Players can create and join clans using the /soulclan commands.
- Clan Link: If a clan member dies, all members lose one life, adding a layer of strategy and teamwork.
Clan Commands:
- /soulclan create <name> - Create a new clan.
- /soulclan invite <player> - Invite a player to your clan.
- /soulclan join <clan> - Accept a clan invitation.
- /soulclan leave - Leave the current clan.
- /soulclan info - View information about the current clan.
8. Cursed Death Drops
- Upon a player’s death, their items become cursed for a configurable duration, meaning only the killer can collect them.
- Cursed Items: After the curse duration expires, the items are available for anyone to loot.
- Soul-bound Items: These items are exempt from the curse.
9. Custom Recipes
The following custom recipes can be used to craft the plugin's unique items:
Soul Revival Totem
DGD
GEG
DGD
- D = Diamond
- G = Gold Block
- E = Emerald Block
Book of Revival
LBL
BEB
LBL
- L = Lapis Block
- B = Book
- E = Experience Bottle
Book of Soul Binding
SES
EBE
SES
- S = Soul Sand
- E = Ender Pearl
- B = Book
Life Essence
GRG
RHR
GRG
- G = Ghast Tear
- R = Redstone Block
- H = Golden Apple
Configuration
config.yml
Below are the configurable settings for
SoulBond Hardcore Plugin.
# Ban players on death (true/false)
ban-on-death: true
# Put players in spectator mode on death (true/false)
spectator-mode-on-death: false
# Default number of lives for players
default-lives: 3
# Maximum number of lives a player can have
max-lives: 5
# Soul Power System
enable-soul-power-system: true
# Clan Soul-Link System
enable-clan-system: true
# Cursed Drops System
enable-cursed-drops: true
cursed-drop-duration: 30
# Soul-Bound Items System
enable-soul-bound-items: true
max-soul-bound-items: 3
# Revival Items System
enable-revival-items: true
enable-revival-books: true
enable-life-essence: true
# Ghost Chat
enable-ghost-chat: true
# Heart Sacrifice
heart-sacrifice-amount: 2
# Custom death messages
custom-death-messages:
- "&c%player% has died and been banned from the server!"
- "&4%player% has fallen in hardcore mode and can't get up!"
- "&c%player% has been eliminated from the hardcore server!"
- "&c%player% has lost their soul to the void!"
- "&4The hardcore world has claimed %player%'s life!"
# Database settings
database:
enabled: false
host: "localhost"
port: 3306
name: "hardcore"
user: "root"
password: ""
Commands
Player Commands:
- /revive - Revive a player who has died.
- /soulclan create - Create a new Soul Clan.
- /soulclan invite - Invite a player to your clan.
- /soulclan join - Join a clan you were invited to.
- /soulclan leave - Leave your current clan.
- /soulclan info - Show information about your clan.
Admin Commands:
- /hardcore.admin - Admin permission to bypass restrictions.
- /revive - Bypass health or item requirements to revive players.
Permissions
- hardcore.revive - Permission to revive players.
- hardcore.soulclan - Permission to use the Soul Clan system.
- hardcore.soulbind - Permission to bind items to the soul.
- hardcore.uselifeessence - Permission to use life essence items.
- hardcore.admin - Admin permission to bypass all restrictions.
Installation
- Download the plugin JAR file.
- Place the JAR file in your server’s plugins folder.
- Restart your server.
- Configure the plugin by editing the config.yml file found in plugins/SoulBond/config.yml.
Data Storage
- YAML Files: Default storage method for small servers.
- MySQL Database: Optional storage for larger networks. Enable and configure in the config.yml file.
Compatibility
- Spigot and Paper servers
- Minecraft 1.20+ and 1.21+
- Compatible with most permission and economy plugins.
Support
For support, bug reports, or feature requests:
- Contact the author.
- Open an issue on the plugin’s repository.
Thank you for using the
SoulBond Hardcore Plugin. Enjoy the enhanced hardcore survival experience!