Descriptions:
BlockMiner is a powerful and feature-rich mining plugin that allows players to mine in a 3x3 area with a single block break. It includes advanced features such as tool-specific mining, cooldowns, player statistics tracking, and a comprehensive database system. The plugin is designed to be highly configurable and user-friendly, providing an enhanced mining experience while maintaining server performance.
Features
Core Mining Mechanics
- 3x3 Mining: Players can break a 3x3 area of blocks with a single block break when enabled
- Tool-Specific Mining:
- Stone-like blocks (stone, deepslate, andesite, granite, diorite, tuff) require diamond or netherite pickaxes
- Dirt-like blocks (dirt, grass_block, coarse_dirt, podzol, mycelium, rooted_dirt) require diamond or netherite shovels
- Action Bar Notifications: Mining results appear in the action bar above the hotbar instead of chat
- Mining Cooldown: Configurable cooldown (default 0.5ms) to prevent excessive mining and server lag
Player Management
- Toggle Command: Players can enable/disable 3x3 mining with /bm on and /bm off
- Player Statistics: Tracks blocks mined, current mode, time since last use, and total sessions
- Session Tracking: Counts each time a player enables 3x3 mode as a session
- Database Storage: Saves player data (UUID, username, stats) in a JSON file for persistence
Commands & Permissions
- Commands:
- /bm on - Enable 3x3 mining mode
- /bm off - Disable 3x3 mining mode
- /bm reload - Reload plugin configuration (requires permission)
- /bm stats - View your mining statistics
- /bm help - Display help information
- Permissions:
- blockminer.use - Allows use of plugin features
- blockminer.reload - Allows reloading configuration
Configuration
- Fully Configurable: All messages, cooldowns, and settings customizable via config.yml
- Message Customization: All in-game messages can be edited, including colors and formatting
- Tool and Block Lists: Easily configure which tools and blocks are allowed for 3x3 mining
Visual Features
- Special Font: Uses unique font (ᴀʙᴄᴅᴇꜰɢʜɪᴊᴋʟᴍɴᴏᴘǫʀѕᴛᴜᴠᴡxʏᴢ) for distinctive look
- Title Notifications: When enabling/disabling, players see a title and subtitle
- Action Bar Messages: Mining results appear in action bar to avoid chat clutter
Performance & Optimization
- Thread-Safe Design: Uses concurrent collections for safe multi-threaded operations
- Efficient Data Storage: Player data saved asynchronously to prevent server lag
- Cooldown System: Prevents excessive mining actions to maintain server performance
Installation
- Download BlockMiner.jar
- Place it in your server's plugins folder
- Restart the server
- Plugin will automatically generate necessary configuration files and database folder
Configuration Files
The plugin creates:
- config.yml: Main configuration for settings, messages, and permissions
- database/players.json: Stores player data (UUID, username, statistics)
Commands
- /bm on - Enable 3x3 mining mode
- /bm off - Disable 3x3 mining mode
- /bm reload - Reload plugin configuration (requires blockminer.reload permission)
- /bm stats - View your mining statistics
- /bm help - Display help information
Permissions
- blockminer.use - Allows players to use the plugin
- blockminer.reload - Allows reloading the configuration
Dependencies
- Minecraft version: 1.16.5 or higher (tested on 1.20.x)
- No external dependencies (uses only Bukkit API)