zNxPiglinRush

# 🔥 zNxPiglinRush !(https://cdn.modrinth.com/data/cached_images/77c5d74f3c5da37b17462cecf618153389635695.png) **A multi-block Nether spawner framework — boost mob spawns on any block type, with wave mode, live statistics, spawn heatmap, custom loot and full Folia support.** Vanilla already spawns Zombified Piglins above magma blocks in the Nether, but the rate is painfully slow. zNxPiglinRush hooks into every natural spawn, fires multiple extra spawns in the surrounding area, and gives you a complete toolset to monitor, tune and maximise your farms. --- ## ✨ Features - **Multi-block spawner framework** — configure *any* block type as a spawner with its own mob, rates and loot. Magma block for gold, soul sand for Wither Skeletons, netherrack for Magma Cubes — all at once - **Two spawn strategies** — *Standard*: immediate extra spawns per trigger. *Wave mode*: accumulate credits and fire scaled burst waves with progressive scaling - **Custom loot injection** — per-spawner drop rules with configurable chance and amounts, injected directly into vanilla death drops - **Spawn statistics** — session, total (SQLite-persisted across restarts), hourly ring buffer and per-mob breakdown via `/pr stats` - **Spawn heatmap** — `/pr heatmap ` toggles a live particle overlay above tracked blocks, coloured blue → yellow → red by spawn density - **TPS diagnostics** — async TPS monitor with configurable alert threshold, in-game op warnings and a `/pr diagnostics` performance report - **Config updater** — automatically migrates old config files to the current schema on startup, preserving all your values and creating a timestamped backup - **PlaceholderAPI** — 8 placeholders for scoreboards and tab lists - **Folia-native** — two scheduler implementations (`FoliaSchedulerService` / `BukkitSchedulerService`) selected at runtime, zero issues on region-threaded servers - **Async update checker** — Modrinth API v2, clickable in-game notification for ops on join - **Zero NMS** — pure Bukkit/Spigot/Paper API, no reflection in hot paths - **Live reload** — `/pr reload` applies all config and registry changes with no restart --- ## 🚀 Quick Start 1. Drop the `.jar` into your `plugins/` folder 2. Restart the server 3. Edit `plugins/zNxPiglinRush/config.yml` 4. Run `/pr reload` — done --- ## ⚙️ Configuration ```yaml enabled: true active-worlds: # leave empty = all worlds debug: false spawners: # Each block gets its own section — add as many as you like magma_block: mob: ZOMBIFIED_PIGLIN spawn-count: 3 # total mobs per trigger (vanilla = 1) spawn-cooldown: 20 # ticks between spawns on the same block max-nearby-entities: 12 # entity cap within scan-radius scan-radius: 10 extra-attempts: 1 # random bonus attempts per trigger wave-mode: false # true = burst waves instead of immediate spawns wave-size: 5 wave-cooldown: 100 # ticks between wave fires custom-drops: - material: GOLD_NUGGET min: 1 max: 3 chance: 0.3 - material: GOLDEN_SWORD min: 1 max: 1 chance: 0.05 # soul_sand: # mob: WITHER_SKELETON # spawn-count: 2 # ... diagnostics: tps-alert-threshold: 18.0 alert-cooldown-seconds: 300 update-checker: true ``` ### Tuning guide | Server type | `spawn-count` | `spawn-cooldown` | `max-nearby-entities` | |---|---|---|---| | Low-TPS / small | `2` | `40` | `8` | | Standard | `3` | `20` | `12` | | Dedicated farm server | `5` | `10` | `20` | > 📉 If TPS drops, lower `spawn-count` or raise `spawn-cooldown` first. --- ## 💬 Commands & Permissions | Command | Alias | Description | |---|---|---| | `/piglinrush reload` | `/pr reload` | Reload config & spawner registry | | `/piglinrush info` | `/pr info` | Runtime, registered blocks, update status | | `/piglinrush stats` | `/pr stats` | Session / total / hourly spawn stats | | `/piglinrush heatmap ` | `/pr heatmap` | Toggle particle heatmap (player only) | | `/piglinrush diagnostics` | `/pr diag` | TPS report and performance suggestions | | `/piglinrush toggle` | `/pr toggle` | Toggle hint | **Permission node:** `piglinrush.admin` (default: `op`) --- ## 📊 PlaceholderAPI | Placeholder | Returns | |---|---| | `%piglinrush_total%` | Total spawns since server start | | `%piglinrush_session%` | Spawns since last `/pr reload` | | `%piglinrush_last_hour%` | Spawns in the last hour | | `%piglinrush_last_24h%` | Spawns in the last 24 hours | | `%piglinrush_status%` | `ENABLED` / `DISABLED` | | `%piglinrush_tps%` | Current average TPS | | `%piglinrush_spawners%` | Number of registered spawner blocks | | `%piglinrush_version%` | Plugin version | --- ## ❓ FAQ **Does this affect overworld magma blocks?** No. The plugin fires only when vanilla already triggers a spawn — in the Nether on magma blocks. Overworld magma blocks don't trigger natural piglin spawns, so the plugin has no effect there. **Does it break v