PlayerImmortal

A lightweight Bukkit/Spigot/Paper plugin that gives operators (OP) god-mode immunity, preventing death from any damage source.

PlayerImmortal is a minimalistic plugin that allows OP players to toggle immortality on themselves. When active, the player cannot die – health will never drop below 1 heart (half a heart). Perfect for server administrators who need to test mechanics without the risk of dying, or for builders in dangerous environments.

---

📑 Table of Contents

• About
• Features
• Installation
• Quick Start
• Commands & Permissions
• Configuration
• Building from Source
• FAQ
• Acknowledgments
• License

---

📖 About

PlayerImmortal was created to provide a simple, no‑frills way for server operators to enable temporary invulnerability. While creative mode or /god commands exist in other plugins, this plugin focuses on simplicity and lightweight performance – it only does one thing and does it well.

It is designed for:

• Server Administrators – who need to test redstone, combat, or parkour without dying.
• Builders – who work in survival mode but don’t want to be interrupted by mobs or falls.
• Plugin Developers – who want a minimal example of a Bukkit event listener and command.

Key use cases:

• Quickly toggle immortality with a single command.
• Stay alive while testing game mechanics.
• Avoid accidental death during server maintenance.

---

✨ Features

• 🛡️ Toggle Immortality – Use /immortal to turn god-mode on or off.
• ❤️ Health Floor – Health will never drop below 1.0 HP, preventing death.
• 🔒 Operator Only – Only players with OP privileges can use the command.
• ⚡ Lightweight – No configuration files, no database, no bloat.
• 🎮 Compatible – Works on Bukkit, Spigot, and Paper 1.21.*.
• 📦 Zero Dependencies – Pure Bukkit API, no external libraries.

---

📦 Installation

Manual installation (JAR)

1. Download the latest PlayerImmortal.jar from the Modrinth page.
2. Place the JAR file into your server's plugins/ folder.
3. Restart your server (or use a plugin manager like /reload – though a full restart is recommended).

---

🚀 Quick Start

1. Start your server with the plugin installed.
2. Become OP (if not already):

   /op YourName
   

3. Toggle immortality:

   /immortal
   

   • First execution: §aImmortal on – you are now invincible.
   • Second execution: §cImmortal off – immortality disabled.
4. Test it – jump from a high cliff or let a zombie hit you; your health will never reach zero.

---

🛡 Commands & Permissions

Command	Permission	Description
/immortal	(none – OP only)	Toggles immortality for the executing player.

• The command does not require a specific permission node; it checks if the sender is OP (player.isOp()).
• Only players can execute the command – console senders are rejected.
• The plugin does not expose any other commands or subcommands.

---

⚙️ Configuration

PlayerImmortal does not use a configuration file.
All behaviour is hardcoded for simplicity. There are no settings to adjust – just drop it in and use it.

If you wish to customise messages or add permissions, please consider forking the project and modifying the source.

---

🏗 Building from Source

If you prefer to build the plugin yourself:

1. Clone the repository:

   git clone https://github.com/yourusername/PlayerImmortal.git
   cd PlayerImmortal
   

2. Ensure you have Java 17+ and Maven installed.
3. Build:

   mvn clean package
   

4. The compiled JAR will be in target/PlayerImmortal-{version}.jar. Copy it to your server's plugins/ folder.

---

❓ FAQ

Q: Does this work on versions other than 1.21?
A: The plugin is built against the 1.21.1 API. It may work on older versions that support the EntityDamageEvent API, but we only officially support 1.21.*.

Q: Can I give the command to non-OP players?
A: Currently, no. The plugin explicitly checks player.isOp(). If you need permission-based control, you can modify the source or use a permission plugin with a wrapper.

Q: What happens when I toggle immortality on?
A: You will receive a message §aImmortal on. Your health will be capped at 1.0 HP when damage would otherwise kill you. You can still take damage, but you cannot die.

Q: Does it work with other damage sources (fall, fire, void, etc.)?
A: Yes, it cancels all EntityDamageEvent sources by reducing the damage so that health never reaches 0.

Q: I found a bug. Where do I report it?
A: Please open an issue on the GitHub Issues page with steps to reproduce and your server logs.

---

🙏 Acknowledgments

• Bukkit/Spigot/Paper API – for providing the Minecraft server interface.
• All contributors and testers who help improve this plugin.

---

📄 License

This project is licensed under the GNU General Public License v3.0 – see the LICENSE file for details.

---

Built with ❤️ by Mr_Catcraft