Chunky Extended

# Chunky Extension A Minecraft server plugin that automatically pauses/resumes (https://github.com/pop4959/Chunky) chunk generation based on server player count, TPS and other settings ## How It Works 1. **Player leaves** → after `delay` seconds, checks player count ≤ `players-to-start` and TPS > `tps-limit` → resume/start generation 2. **Player joins** → when online ≥ `players-to-pause` → pause all running tasks 3. **TPS monitoring** → every `tps-check-interval` seconds, if TPS ≤ `tps-limit` → pause + notify 4. **Generation complete** → console log + Discord/Telegram notification ## Downloads | JAR | Server Type | Java | Minecraft | |---|---|---|---| | `chunky-extension-legacy-*.*.*.jar` | Spigot, Bukkit | 8+ | 1.13.2 –> 1.16.5 | | `chunky-extension-paper-*.*.*.jar` | Paper, Purpur, Folia | 17+ | 1.17 –> 26.2 | ## Features - Auto-pause Chunky when players join, auto-resume when server is empty - Configurable player thresholds, delay, TPS monitoring - Multi-world support with per-world generation settings - Discord webhook & Telegram bot notifications with per-message control - WorldBorder radius auto-detection - Parallel generation control - Folia/Regionized scheduler support (Paper JAR) - Generation complete notifications - Config reload via `/ce reload` ## Requirements - (https://github.com/pop4959/Chunky) plugin installed - Java 8+ (legacy) or Java 17+ (paper) ## Installation 1. Download the correct JAR for your server from (https://github.com/MisterFenek/chunky-extension/releases) 2. Place in `plugins/` folder 3. Restart server 4. Edit `plugins/ChunkyExtension/config.yml` and `integrations.yml` 5. Run `/ce reload` or restart ## Commands | Command | Permission | Description | |---|---|---| | `/chunkyext reload` | `chunkyext.reload` | Reload configuration | | `/chunkyext status` | `chunkyext.command` | Show current status | Aliases: `/ce`, `/cext` ## Permissions | Permission | Default | Description | |---|---|---| | `chunkyext.command` | `op` | Use `/ce` commands | | `chunkyext.reload` | `op` | Reload config via `/ce reload` | ## Configuration ### config.yml <details> <summary>Click to expand</summary> ```yaml # Do not edit the version field. version: 1 settings: # Minimum online players to START Chunky generation when server was empty. players-to-start: 0 # Pause Chunky generation when this many players are online. players-to-pause: 1 # Seconds to wait after the last player leaves before resuming generation. delay: 10 # Pause Chunky when server TPS drops to or below this value. tps-limit: 18 # How often (in seconds) to check server TPS. tps-check-interval: 5 # Allow Chunky to generate multiple worlds simultaneously. parallel-generation: false # Auto-detect WorldBorder radius for each world (not yet implemented). worldborder-radius: false # Log Chunky progress events to console. progress-logging: false # Worlds to pre-generate. Each entry needs: # radius - generation radius in blocks from world spawn (0,0) # shape - "square" or "circle" # pattern - "concentric", "spiral", or "random" worlds: world: radius: 500 shape: square pattern: concentric ``` </details> ### integrations.yml <details> <summary>Click to expand</summary> ```yaml discord: enabled: false webhook-url: "https://discord.com/api/webhooks/YOUR_WEBHOOK" username: "Chunky Extension" avatar-url: "" messages: resume: enabled: true text: "▶️ Chunky generation resumed in {world} (players: {players})" pause: enabled: true text: "⏸️ Chunky generation paused in {world} (players: {players})" start: enabled: true text: "🚀 Chunky generation started in {world} (radius: {radius})" complete: enabled: true text: "✅ Chunky generation completed in {world}!" tps-pause: enabled: true text: "⚠️ Chunky paused in {world} — TPS too low ({tps})" error: enabled: true text: "❌ Failed to start/resume Chunky in {world}" telegram: enabled: false bot-token: "YOUR_BOT_TOKEN" chat-id: "YOUR_CHAT_ID" topic-id: "" messages: resume: enabled: true text: "▶️ Chunky generation resumed in {world} (players: {players})" pause: enabled: true text: "⏸️ Chunky generation paused in {world} (players: {players})" start: enabled: true text: "🚀 Chunky generation started in {world} (radius: {radius})" complete: enabled: true text: "✅ Chunky generation completed in {world}!" tps-pause: enabled: true text: "⚠️ Chunky paused in {world} — TPS too low ({tps})" error: enabled: true text: "❌ Failed to start/resume Chunky in {world}" ``` **Per-message options:** `enabled` (boolean), `text` (string with placeholders) **Placeholders:** `{world}`, `{players}`, `{radius}`, `{tps}` </details>