Better Veinminer

Version: 1.2.0 | API: Paper 1.21+ | Author: Duong2012G

Mine an entire ore vein in one swing — with tier progression, statistics, custom rewards, and advanced permissions!

---

🎮 Features

Core Features

• 26-direction BFS — finds diagonal ore connections just like Minecraft generates them
• Strict same-type matching — only collect ores matching the block you break
• Fortune & Silk Touch — work automatically on every block in the vein
• Per-player toggle — each player can enable/disable veinminer independently
• Respects Unbreaking — durability calculation uses correct Minecraft probability formula
• World whitelist/blacklist — restrict which worlds allow veinminer
• Hot reload — no server restart needed for config changes

🆕 Advanced Features (v1.2.0+)

📊 Tier System

Players automatically progress through 4 tiers as they mine more blocks:

• Tier 1 — 32 max blocks (starting tier, 0 blocks mined)
• Tier 2 — 64 max blocks (100,000 blocks mined)
• Tier 3 — 128 max blocks (500,000 blocks mined)
• Tier 4 — 256 max blocks (1,000,000 blocks mined)

Check your tier with /bvm tier!

📈 Player Statistics

Track your progress with /bvm stats:

• Total blocks mined via veinminer
• Current tier level
• Number of veinmines performed
• Progression to next tier

🏆 Permission-Based Limits

Give VIP and Premium players special treatment:

• betterveinminer.vip — Higher max blocks + lower cooldown
• betterveinminer.premium — Highest max blocks + lowest cooldown

Example in config:

permission-levels:
  betterveinminer.vip:
    max-blocks: 128
    cooldown-ms: 100

💎 Ore Multipliers

Configure different drop multipliers per ore type:

ore-multipliers:
  enabled: true
  multipliers:
    DIAMOND_ORE: 1.5        # 1.5x drops
    EMERALD_ORE: 2.0        # 2x drops
    COAL_ORE: 0.5           # 0.5x drops

⏱️ Per-Ore Cooldowns

Set different cooldown times for different ores:

per-ore-cooldowns:
  enabled: true
  cooldowns:
    DIAMOND_ORE: 1000       # 1 second cooldown
    COAL_ORE: 200           # 200ms cooldown

📅 Daily Limits

Prevent abuse by limiting veinmines per player per day:

daily-limits:
  enabled: true
  limit-per-day: 10         # Max 10 veinmines per day

✨ Custom Effects

Control particle and sound effects in detail:

effects:
  particle-type: BLOCK      # BLOCK, SMOKE, FLAME, ENCHANT, etc.
  particle-color: "0xFFD700"
  particle-speed: 1.0
  completion-sound: BLOCK_STONE_BREAK
  warning-sound: ENTITY_ITEM_PICKUP

💬 Custom Messages

Fully customizable player notifications:

messages:
  veinmine-success: "§a[VM] §fBroke §e{count} §fblocks!"
  tier-up: "§6[VM] §fYou reached §eTier {tier}§f!"
  stats: "§a[VM] Stats: §fBlocks: §e{blocks}§f | Tier: §e{tier}"

⚡ Custom EXP Rewards

Give bonus XP for veinmining:

exp-settings:
  enabled: true
  base-exp: 10              # Base EXP per veinmine
  per-extra-block: 5        # EXP per additional block

---

📥 Installation

1. Download BetterVeinminer-1.2.0.jar
2. Drop it in your server's plugins/ folder
3. Restart or reload the server
4. Edit plugins/BetterVeinminer/config.yml as needed
5. Use /bvm reload to apply config changes without restarting

---

🔐 Permissions

Permission	Description	Default
betterveinminer.use	Use veinminer + /bvm toggle/stats/tier	true (everyone)
betterveinminer.admin	Reload config (/bvm reload)	op
betterveinminer.vip	VIP tier (custom limits)	false
betterveinminer.premium	Premium tier (best limits)	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 of the same type drops at once

Fortune & Silk Touch

All blocks in the vein use your pickaxe's Fortune level automatically!

• Fortune — Multiplies ore drops (diamonds, redstone, etc.)
• Silk Touch — Drops ore blocks instead of raw materials

Both work automatically, no configuration needed!

---

📋 Configuration Guide

Basic Settings

enabled: true              # Enable/disable the entire plugin
require-sneak: true        # Players must sneak to activate
require-pickaxe: true      # Players must hold a pickaxe
max-blocks: 64             # Max blocks per veinmine
cooldown-ms: 200           # Cooldown between veinmines (milliseconds)
damage-tool: true          # Pickaxe takes durability damage
damage-multiplier: 1.0     # Multiplier for durability loss

World Restrictions

whitelist-worlds:          # Only allow in these worlds
  - world
  - world_nether

# OR use blacklist to block specific worlds:
blacklist-worlds:
  - creative_world

Ore Types

Configure which blocks trigger veinminer:

ore-types:
  - COAL_ORE
  - DIAMOND_ORE
  - EMERALD_ORE
  - IRON_ORE
  # ... and many more!

Tool Whitelist

Which pickaxes can trigger veinminer:

tool-whitelist:
  - WOODEN_PICKAXE
  - STONE_PICKAXE
  - IRON_PICKAXE
  - GOLDEN_PICKAXE
  - DIAMOND_PICKAXE
  - NETHERITE_PICKAXE

---

📝 Configuration Examples

Example 1: VIP Server Setup

# Enable all premium features for VIPs
tier-system:
  enabled: true

permission-levels:
  betterveinminer.vip:
    max-blocks: 256
    cooldown-ms: 50

ore-multipliers:
  enabled: true
  multipliers:
    DIAMOND_ORE: 2.0
    EMERALD_ORE: 2.5

Example 2: Balanced Survival Server

# Tier system enabled, normal cooldown
tier-system:
  enabled: true
  tier-2-threshold: 50000      # Lower thresholds for faster progression
  tier-3-threshold: 250000
  tier-4-threshold: 500000

daily-limits:
  enabled: true
  limit-per-day: 5             # Prevent spamming

Example 3: Hardcore Mode

# High cooldown, small max blocks
max-blocks: 16
cooldown-ms: 2000              # 2 second cooldown

tier-system:
  enabled: false               # No progression

damage-multiplier: 2.0         # Tool takes 2x damage

---

🐛 Troubleshooting

Q: Veinminer isn't working!
A: Check these things:

• Is the plugin enabled? (enabled: true in config)
• Does the ore type exist in ore-types?
• Are you holding a pickaxe from tool-whitelist?
• Are you sneaking (if require-sneak: true)?
• Is the world not blacklisted?

Q: Tier system isn't progressing!
A: Make sure tier-system.enabled: true in config, and the thresholds are reasonable.

Q: Cooldown seems broken!
A: Check cooldown-ms value. If it's 0, there's no cooldown. Default is 200ms.

Q: My custom messages don't work!
A: Make sure to use proper color codes (§a, §e, etc.) and proper placeholders ({count}, {tier}).

---

🔄 Changelog

See CHANGELOG.md for version history.

---

📜 License

Apache-2.0 © Duong2012G

---

🤝 Support

For issues or feature requests, visit:
https://modrinth.com/user/Duong2012G

---

🎯 Tips & Tricks

1. Speed up progression — Lower tier thresholds in config
2. Add custom sounds — Use any valid Minecraft Sound enum value
3. Balance economy — Adjust ore multipliers to match your server's economy
4. Prevent lag — Lower max-blocks on heavily-played servers
5. Admin control — Use permission levels to reward donors/VIPs

Enjoy! 🎮