Vein Miner Plugin
Vein Miner Plugin (1.20.1, 1.19.4) aims to recreate exactly that in an efficient, flexible and feature-filled way. Anything you’ve ever seen from the VeinMiner mod should be in the VeinMiner plugin, of course with a few minor feature changes due to the limitations of server modifications. If you have not yet used the VeinMiner mod… play more mod packs.
Features
VeinMiner allows players to mine an entire vein of ores whilst sneaking and breaking an ore. It will break the entire vein when only needing to break one ore. Much like the original mod, there is an extremely powerful block list which can be modified in-game, as well as in the configuration file, to determine which blocks (and which data values) are capable of being vein mined. The lists are separated by tools and can be grouped by aliases to allow for a more flexible and simplistic mining experience. This is a fantastic perk for Prison, Factions and Semi-Vanilla servers that isn’t overpowered, but still gives players a rewarding benefit for donating to your server.
Commands
Commands for VeinMiner are lacking in features, but they can be useful for configuring most of the resource without having to open the configuration file, and they accomplish their purpose.
/veinminer [alias: “/vm”]:
Description:Â The central command for VeinMiner that controls various aspects of the resource including block list manipulation, tool toggle, and basic information
Sub-commands:<reload>Â – Reload the plugin’s configuration file and load everything back into memory
<version>Â – Retrieve version information of the VeinMiner currently installed on your server
<blocklist> <*tool>Â – Tools are the same as those listed in the configuration file<add> <id> [data]Â – Add a block to the tools block list (data is optional)
<remove> <id> [data]Â – Remove a block from the tools block list (data is optional)
<list>Â – List all blocks currently on this tools block list<toggle> [tool]Â – Toggle vein miner on or off for all (or specific) tools
<pattern> <namespace:key>Â – Set the pattern to be used while vein miningExample:
– /veinminer blocklist pickaxe add stone
– /veinminer blocklist shovel remove dirt 1
– /veinminer toggle axe
– /veinminer pattern veinminer:default[/SIZE]
Permission Nodes
veinminer.veinmine.*:
Description: Allow the ability to use VeinMiner for all tools
Default: All players have this permission by default
Children:
veinminer.veinmine.pickaxe: Allow the ability to use VeinMiner for pickaxes
veinminer.veinmine.axe: Allow the ability to use VeinMiner for axes
veinminer.veinmine.shovel: Allow the ability to use VeinMiner for shovels
veinminer.veinmine.shears: Allow the ability to use VeinMiner for shears
veinminer.veinmine.hoe: Allow the ability to use VeinMiner for hoes
veinminer.veinmine.hand: Allow the ability to use VeinMiner for materials in the hand category
veinminer.blocklist.*:
Description:Â Allow access to the “/veinminer blocklist” sub-command, and all of its sub-commands, “add”, “remove” and “list”
Default:Â Operators have this permission by default
Children:
veinminer.blocklist.add:Â Allow access to the “/veinminer blocklist add” sub-command
veinminer.blocklist.remove:Â Allow access to the “/veinminer blocklist remove” sub-command
veinminer.blocklist.list:Â Allow access to the “/veinminer blocklist list” sub-command
veinminer.reload:
Description:Â Allow access to the “/veinminer reload” sub-command
Default:Â Operators have this permission by default
veinminer.toggle:
Description:Â Allow access to the “/veinminer toggle” sub-command
Default:Â All players have this permission by default
veinminer.pattern:
Description:Â Allow access to the “/veinminer pattern” sub-command
Default:Â All players have this permission by default
VeinMiner API
The API for VeinMiner has been constantly changing during its development, but it’s now reached a state where it should remain relatively stable. There are various aspects of the API that can be manipulated by an external plugin, and if you’re interested in doing so, you are welcome to check out the numerous pages on the Spigot Wiki that can be found by clicking the respective topic below:
- [TODO] Listening for when players vein mining
- [TODO] Manipulating blocklists / player capabilities
- [TODO] Registering custom material aliases
Screenshots:
How to install:
- Download a plugin of your choice.
- Place the .jar and any other files in your plugins directory.
- Run the server and wait for it to fully load.
- Type stop in your Minecraft server console to bring the server to a clean stop.
- Run the server.
- All done! Your plugin should be installed and ready to be used.