Files
anti-creep/README.md
T

107 lines
3.5 KiB
Markdown

# Anti-Creep (NoCreeperExplosions)
[![Minecraft](https://img.shields.io/badge/Minecraft-1.21+-brightgreen.svg)](https://papermc.io/)
[![PaperMC](https://img.shields.io/badge/Platform-Paper%20%7C%20Purpur%20%7C%20Spigot-blue.svg)](https://papermc.io/)
[![Java](https://img.shields.io/badge/Java-21+-orange.svg)](https://adoptium.net/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
**Anti-Creep** (`NoCreeperExplosions`) is a lightweight, zero-configuration Minecraft server plugin built for Paper, Purpur, and Spigot (1.21+). It stops both standard and charged creepers from destroying blocks and griefing builds, while preserving vanilla mob spawning and combat mechanics.
---
## ✨ Features
- 💥 **Anti-Grief Explosion Suppression**: Automatically intercepts and cancels creeper explosions to prevent terrain and structure destruction.
- ⚡ **Charged Creeper Coverage**: Handles both normal creepers and high-yield supercharged creepers.
- ⚡ **Zero Performance Overhead**: Lightweight single-event listener design with negligible memory and CPU impact.
- 🔌 **Plug and Play**: No configuration files or complex setup needed—drop it into your plugins folder and it works immediately.
---
## 📋 Requirements
| Component | Minimum Version | Recommended |
|---|---|---|
| **Java** | 21+ | JDK / JRE 21 or 25 |
| **Server Software** | Paper 1.21+ | Paper / Purpur 1.21.x |
---
## 📥 Installation
1. Download the latest plugin jar (`NoCreeperExplosions-1.0-SNAPSHOT.jar`) or [build from source](#-building-from-source).
2. Place the `.jar` into your server's `plugins/` directory.
3. Start or restart your server.
4. Verify the plugin is enabled:
```text
[INFO] [NoCreeperExplosions] Enabling NoCreeperExplosions v1.0
[INFO] [NoCreeperExplosions] NoCreeperExplosions enabled - Creeper explosions disabled.
```
You can also check `/plugins` in-game or in the server console.
---
## 🛠️ Building from Source
### Prerequisites
- **JDK 21** or newer
- **Git**
- *(Optional)* Apache Maven 3.9+ (the repository includes the Maven Wrapper `mvnw`, so manual Maven installation is not required)
### Build Steps
1. **Clone the repository:**
```bash
git clone https://gitea.jadonsandbox.com/jkortis/anti-creep.git
cd anti-creep
```
2. **Package the plugin:**
- **Windows (Command Prompt / PowerShell):**
```cmd
.\mvnw.cmd clean package
```
- **Linux / macOS:**
```bash
chmod +x mvnw
./mvnw clean package
```
3. **Locate the JAR:**
The output artifact will be generated at:
```text
target/NoCreeperExplosions-1.0-SNAPSHOT.jar
```
---
## 📂 Project Structure
```text
anti-creep/
├── .mvn/
│ └── wrapper/
│ └── maven-wrapper.properties
├── src/
│ └── main/
│ ├── java/
│ │ └── me/
│ │ └── nocreeperexplosions/
│ │ ├── CreeperExplosionListener.java # Event listener handling explosion cancellation
│ │ └── NoCreeperExplosions.java # Main Paper plugin lifecycle class
│ └── resources/
│ └── plugin.yml # Plugin description metadata
├── .gitignore
├── LICENSE
├── mvnw
├── mvnw.cmd
├── pom.xml # Maven build specification
└── README.md
```
---
## 📄 License
This project is licensed under the [MIT License](LICENSE).