Overview

VeinMiner

Table of Contents

If you have ever used the Minecraft Forge mod, VeinMiner, this plugin 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.

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.

DISCLAIMER: I am in no way related to or in collaboration with the Minecraft Forge VeinMiner project, or the creator portablejim. This is simply a recreation of a popular mod to be enjoyed on CraftBukkit / Spigot servers.

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

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

For those of you that like to explore projects on your own and see what you can do, VeinMiner is completely documented and filled with detailed information over every single class, method and constant. There are Javadocs hosted on my website for you to browse, and you can find them here: https://choco.gg/javadocs/veinminer/

VeinMiner has been happily open sourced for a long time and is ready to be contributed to! If you are a VeinMiner API user or if you are simply interested in the code that goes behind the inner-workings of this plugin, its source code is available on GitHub for you to browse and hack away at. You can find the source code by going to VeinMiner's public repository. If you are familiar with Git, you are free to clone, fork or make a pull request to VeinMiner. If I approve of any changes you decide to pull request, I may consider merging the changes into the main branch and uploading a version with your code. You will be credited in the very next changelog, as well as a link to your PR.

This resource is brought to you free of charge without any obligation to pay anything! I love to provide free resources such that people are enjoying it on their servers. Unfortunately, not everything in life is free and I will eventually need some monetary support of some kind. If you enjoy this project and what it provides to your server, please do consider donating as a little thank you for my hard work. I spent countless hours working on this project and all of it is provided without asking for anything.

Donating is not a requirement, and I do not expect anyone to donate. If you so chose to donate out of your own good will, I greatly appreciate the support, and I hope that you enjoy this resource as much as I do developing it! Thank you!

Comments

A lot of blocks listed in Spigot have different names than those in the game (i.e. for stained hardened clay, the material name is simply "STAINED_CLAY"). I know, strange, but I have yet to find a way to use vanilla Minecraft identifications without some very coupling code

They may not be running the plugin anymore, unfortunately. I don't monitor these servers and therefore do not keep track whether they are still available or not. I've even redesigned the page over on SpigotMC to remove the server list. This page has been rather neglected other than hosting releases.

What is the issue you are having, though? I can try and help you as best as I can!

I know very little about coding, mods, etc., so I am unsure of how long things normally take to be updated after a new version of the game is released. I've been trying to find a way to use the VeinMiner mod on my CraftBukkit server with no luck. Are you planning to update this plugin anytime soon?

I'm not sure why but I feel as though having it on by default just makes the most sense. A lot of people have this for Factions or Survival as a default feature, and some just have it as perks. Revoking a permission node isn't all that difficult, so I'd rather keep it as enabled by default ^-^ As long as you figured it out, I'm happy, and I'm glad you enjoy the plugin! Best of luck with your server!

I'm not sure why but I feel as though having it on by default just makes the most sense. A lot of people have this for Factions or Survival as a default feature, and some just have it as perks. Revoking a permission node isn't all that difficult, so I'd rather keep it as enabled by default ^-^ As long as you figured it out, I'm happy, and I'm glad you enjoy the plugin! Best of luck with your server!

Fair enough. Might want to add

veinminer.veinmine.*

To the permission page since thats what needed to be revoked to make them not use it always.

I have the current version of spigot and veinminer installed. I got the plugin working on my PC but for some reason it wont load on my hosted server, which makes me think it might be a java issue on their end. Let me know if you can decipher what the error log means.

This is indeed an issue with the version of Java that the host is using. They are hosting on Java 7, and my resource requires Java 8 as it uses Java 8 exclusive features. If you do not have the option to change what version of Java you can launch your server on, contact your host and I'm sure they can change it for you

Hey. Im using your plugin on my server. Is there any way to add a default on or off option on join in the config and is there a way to allow only people with the right perm actervation?? Skype me killson2101917 if u can or cant. or just reply to this post.

There is not a way to disable VeinMiner upon joining. I can most definitely make a configuration option for that though :) As for the permission nodes, absolutely! Those have been implemented for quite some time now. Please do feel free to take a look at the Permissions Page

In order to remove the permissions, you have to negate the permission node with your permission plugin in the base group, (because the permission nodes are set to true by default), then add the permission node to all groups in which you want to allow to use it. Each plugin does permission negation differently. Some plugins prefix permissions with ^, others with -, I couldn't tell you. Check your permission plugin's documentation page for that.

mc19.serveromat.net:40725

It seems that i've got some permission problems. i added "veinminer.toggle" permission available to players but they still can't use veinminer and/or toggle it on and off. Is there a permission to be able to use it?