Better Veinminer

# Better Veinminer **Version:** 1.5.1 | **API:** Paper 1.21+ | **Author:** Duong2012G **License:** Apache-2.0 | **Link:** (https://modrinth.com/user/Duong2012G) Mine an entire ore vein in one swing — with **tier progression, persistent statistics, a custom event API, and deep configuration.** --- ## Features ### Core - **6-direction BFS** — accurate face-adjacent vein detection matching vanilla ore generation; no false positives from diagonal neighbours - **Strict same-type matching** — only collects blocks of the exact same material - **Fortune & Silk Touch** — work automatically on every block in the vein - **Per-player toggle** — each player can enable/disable independently with `/bvm toggle` - **Unbreaking-aware durability** — matches vanilla's per-hit random probability model - **World whitelist/blacklist** — restrict which worlds allow veinminer - **Hot reload** — `/bvm reload` applies config changes without a restart ### Tier System Players progress through 4 tiers as they mine more blocks: | Tier | Blocks Required | Max Blocks (default) | |:----:|:--------------:|:-------------------:| | 1 | 0 | 32 | | 2 | 100,000 | 64 | | 3 | 500,000 | 128 | | 4 | 1,000,000 | 256 | All thresholds and max-block limits are configurable. Check progress with `/bvm tier`. ### Persistent Statistics Stats survive server restarts. Saved per-player to `plugins/BetterVeinminer/stats/<uuid>.yml`: - Total blocks mined via veinminer - Total veinmines performed - Current tier - Auto-save every 5 minutes (thread-safe snapshot) + on player quit ### Daily Limits Cap veinmines per player per day. Resets at real midnight, persisted across restarts in `data.yml`. The counter itself is also persisted — a restart mid-day no longer resets progress toward the daily cap. ### Custom Event API `BetterVeinmineEvent` lets other plugins hook into every veinmine: ```java @EventHandler public void onVeinmine(BetterVeinmineEvent event) { // Cancel completely (e.g. in protected regions) if (isProtected(event.getPlayer())) { event.setCancelled(true); return; } // Double EXP on ancient debris if (event.getOreType() == Material.ANCIENT_DEBRIS) { event.setExpReward(event.getExpReward() * 2); } plugin.getLogger().info(event.getPlayer().getName() + " veinmined " + event.getBlocks().size() + " blocks."); } ``` ### Protection Plugin Support The main `BlockBreakEvent` listener runs at `HIGH` priority (`ignoreCancelled = true`), so protection plugins (WorldGuard, Lands, GriefPrevention, Residence) that cancel the event at `NORMAL` or `LOW` priority are respected — no veinmine task is ever scheduled for a block the player cannot break. For each extra block in the vein a second `BlockBreakEvent` is fired before breaking, allowing region-level per-block checks. Per-block events are guarded by an anti-recursion lock so the plugin never triggers itself in a loop. ### Permission-Based Limits Give VIP/Premium players special treatment via `permission-levels` in config. When a player holds multiple permission nodes, the one with the **highest `max-blocks`** value always takes precedence — no more random ordering. ### Cooldown Feedback When a player is still on cooldown, the remaining time is shown on the action bar using the configurable `cooldown` message and its `{remaining}` placeholder. ### Ore Multipliers Configure different EXP multipliers per ore type. ### Per-Ore Cooldowns Different cooldown per ore type. --- ## Installation 1. Download `BetterVeinminer-1.5.0.jar` 2. Drop into your server's `plugins/` folder 3. Restart or reload the server 4. Edit `plugins/BetterVeinminer/config.yml` 5. Use `/bvm reload` to apply changes without restarting **Requirements:** Paper (or any Paper fork) 1.21+, Java 21+ --- ## Permissions | Permission | Description | Default | |---|---|---| | `betterveinminer.use` | Use veinminer + `/bvm toggle/stats/tier` | `true` | | `betterveinminer.admin` | Reload config (`/bvm reload`) | `op` | | `betterveinminer.vip` | VIP tier (custom limits via config) | `false` | | `betterveinminer.premium` | Premium tier (best limits via config) | `false` | --- ## Commands | Command | Description | Permission | |---|---|---| | `/bvm toggle` | Enable/disable veinminer for yourself | `betterveinminer.use` | | `/bvm stats` | View your mining statistics | `betterveinminer.use` | | `/bvm tier` | Check your current tier & progression | `betterveinminer.use` | | `/bvm reload` | Reload configuration file | `betterveinminer.admin` | --- ## How to Use 1. Hold a pickaxe from `tool-whitelist` 2. Sneak (Shift) if `require-sneak: true` 3. Break any ore block — the entire connected vein drops at once Fortune and Silk Touch both work automatically on every block in the vein. --- ## Configuration Reference ### Basic Settings ```yaml enabled: true