Here is a clean, professional GitHub README styled exactly like high-quality open-source plugins. I improved formatting, spacing, and added badges + sections that GitHub projects usually include.
You can copy-paste this directly into README.md.
🩸 Lifesteal Core X
The Ultimate Lifesteal System for Competitive SMP Servers
A modern, high-performance, and fully modular lifesteal plugin built exclusively for Paper servers.
Built for serious SMP servers
Optimized for performance
Designed for scalability
🚀 Why Lifesteal Core X?
Lifesteal Core X is not just another lifesteal plugin — it is a complete competitive ecosystem designed for modern Minecraft SMP servers.
Key Features
✔ Modular architecture
✔ MySQL-ready database system
✔ Built-in combat system
✔ Anti-farm protection
✔ GUI-based management
✔ PlaceholderAPI support
✔ Live scoreboard system
✔ Optimized for large SMP servers
Compatible with Paper 1.20+ (Java 17+)
❤️ Core Lifesteal System
The heart of the plugin.
Features include:
🩸 Gain hearts when killing players
💀 Lose hearts on death
⚙ Fully configurable minimum & maximum hearts
🗄 Persistent data storage
🔄 Automatic MySQL table creation
🧠 Clean internal API structure
Built for long-term SMP stability.
🛡 Advanced Combat System
Prevent combat logging abuse.
Features:
⏱ Configurable combat duration
🚫 Block commands during combat
⚠ Optional logout punishment
🧩 Fully toggleable system
Perfect for competitive PvP environments.
🚫 Anti-Farm Protection
Stops players from farming hearts.
Includes:
🔁 Kill cooldown tracking
🧮 Per-player farming detection
🌐 Optional same-IP protection
⚙ Configurable cooldown timers
Keeps your server fair and balanced.
📊 Live Scoreboard System
Beautiful real-time sidebar scoreboard.
Displays:
❤️ Hearts
⚔ Kills
💀 Deaths
📈 K/D Ratio
Features:
✔ Configurable refresh rate
✔ Fully customizable layout
✔ Lightweight updates
🧾 Stats & GUI System
Modern inventory GUI interface.
/lifesteal
Opens the main GUI panel
Includes:
📊 Player statistics viewer
🏆 Top 10 leaderboard (MySQL powered)
🔄 Revive menu
🎯 Quick navigation system
Clean. Fast. Intuitive.
🔄 Revive System
Bring eliminated players back.
Features:
💔 Revive banned or eliminated players
❤️ Configurable revive hearts
📢 Optional broadcast message
🧩 GUI revive menu
👑 Admin force revive command
Perfect for lifesteal SMP gameplay.
🗄 Database System
Built to support large servers.
Features:
💾 MySQL database support
🛠 Automatic table creation
⚡ Optimized SQL queries
🔐 Secure connection handling
Designed for scalability and performance.
🔌 PlaceholderAPI Support
Fully integrated placeholders.
%lifesteal_hearts%
%lifesteal_kills%
%lifesteal_deaths%
%lifesteal_kd%
Works with:
TAB
DeluxeScoreboard
Chat plugins
Hologram plugins
Custom scoreboards
📜 Commands
👤 Player Commands
Command | Description -- | -- /lifesteal | Open main GUI /lifesteal stats | View your stats /lifesteal leaderboard | View top players /lifesteal revive | Open revive menuPermission:
lifesteal.admin
Default: OP
⚙ Configuration
Fully customizable system.
Configuration files:
config.yml
database.yml
messages.yml
gui.yml
You can configure:
Default hearts
Maximum hearts
Combat duration
Anti-farm cooldown
Revive system
GUI layout
Scoreboard layout
Custom messages
Everything is modular and cleanly structured.
🛠 Requirements
Required:
Paper 1.20+
Java 17+
Optional:
PlaceholderAPI
🧠 Performance & Optimization
Designed with performance in mind.
⚡ Lightweight architecture
🧮 Optimized SQL queries
🔄 Clean event handling
🚀 Supports high player counts
🧩 Minimal memory usage
Perfect for long-running SMP servers.
📦 Installation
1️⃣ Download the plugin jar
2️⃣ Place it inside the /plugins/ folder
3️⃣ Start your server
4️⃣ Configure the plugin files
5️⃣ Restart server
Done.
📌 Current Version
v1.0 — Initial Stable Release
👨💻 Developer
Developed and maintained by ArchitDev
Professional Paper Plugin Developer
🗺 Roadmap
Upcoming features planned:
🔄 Async MySQL saving
🌍 Bungee / Velocity sync
🔴 Redis support
❤️ Custom heart items
🎖 Rank-based heart bonuses
🎞 Animated scoreboards
📡 Cross-server stats sync
Lifesteal Core X is just getting started.
Full Changelog: https://github.com/architdev01/Lifesteal-Core-X/commits/minecraft-plugin