Configuration Guide

VeinMiner Configuration

Default Values

By default, you will have many values to try and regulate the amount of power this plugin has. Sometimes, it can get a little overpowered, and often, if the integer you set in an option is too high, your CPU may raise a little every time someone VeinMines (Version 1.5.0 has made optimizations to the algorithm, and the CPU spikes may not occur as much anymore). Here is what the default configuration will look like without any modifications to it whatsoever:

MetricsEnabled: true
ActivationMode: 'SNEAK'
RepairFriendlyVeinminer: false
IncludeEdges: true DisabledWorlds: - WorldName Tools: Pickaxe: MaxVeinSize: 64 UsesDurability: true Axe: MaxVeinSize: 64 UsesDurability: true Shovel: MaxVeinSize: 64 UsesDurability: true Hoe: MaxVeinSize: 64 UsesDurability: true Shears: MaxVeinSize: 64 UsesDurability: true BlockList: Pickaxe: - COAL_ORE - IRON_ORE - GOLD_ORE - LAPIS_ORE - REDSTONE_ORE - GLOWING_REDSTONE_ORE - DIAMOND_ORE - EMERALD_ORE - QUARTZ_ORE Axe: - LOG - LOG_2 - MELON_BLOCK - PUMPKIN - HUGE_MUSHROOM_1 - HUGE_MUSHROOM_2 Shovel: - SAND - GRAVEL Hoe: - CROPS;7 - POTATO;7 - CARROT;7 - BEETROOT_BLOCK;3 - RED_MUSHROOM - BROWN_MUSHROOM Shears: - WOOL - WEB - LEAVES - LEAVES_2 All: - ICE - PACKED_ICE
Aliases:
- REDSTONE_ORE,GLOWING_REDSTONE_ORE
- HUGE_MUSHROOM_1,HUGE_MUSHROOM_2
- LOG;0,LOG;4,LOG;8,LOG;12
- LOG;1,LOG;5,LOG;9,LOG;13
- LOG;2,LOG;6,LOG;10,LOG;14
- LOG;3,LOG;7,LOG;11,LOG;15
- LOG_2;0,LOG_2;2,LOG_2;4,LOG_2;6
- LOG_2;1,LOG_2;3,LOG_2;5,LOG_2;7
- LONG_GRASS,DOUBLE_PLANT

MetricsEnabled:

ActivationMode:

  • The mode that will cause VeinMiner to activate whilst mining. There are 2 available values, and if a proper value is not applied, the plugin will seize to function
  • Possibles values:
    • 'SNEAK': Activates whilst breaking a block and sneaking
    • 'STAND': Activates whilst breaking a block and standing up (Not sneaking)

RepairFriendlyVeinminer:

  • Whether vein mining will stop to allow for a tool repair or not
  • Possibles values:
    • true: VeinMiner will stop mining when your tool durability is at 0, allowing for repair
    • false: VeinMiner will continue mining until your tool is broken

IncludeEdges:

  • Whether vein mining will include the edges of blocks or not
  • Possibles values:
    • true: VeinMiner will include all corners and edges when mining veins
    • false: VeinMiner will ignore corners and edges, and instead only mine on a limited axis (Useful for laggy servers)

DisabledWorlds:

  • This is a list value in which you determine which worlds VeinMiner is disabled in. There is already an example world provided in which you may follow
  • Specify a list of all world names (Capitalization matters) you wish VeinMiner to be disabled in

MaxVeinSize:

  • The maximum vein size that a VeinMine can destroy. By default, this should be set to 64 as it is not too much yet not too little
  • This requires an integer value with no limit on how high it can go
    • NOTE: The higher the "MaxVeinSize" value is, the more the VeinMine algorithm has to make decisions. Although the algorithm is no longer as intensive (1.5.0+), it is still recommended that you stay below the value of 128

UsesDurability:

  • This one seems pretty straight forward from the title of the configuration option. This will determine whether VeinMiner uses durability on the tool or not
  • This requires a boolean value. Setting it to true will damage the tool with the respective amount of durability, and setting it to false will not damage the pickaxe at all

BlockList:

  • This is a list value in which you determine which blocks are affected by VeinMiner
  • Be careful about which items you put in this list, because they are using the BUKKIT variations of the item ID. For example: "minecraft:iron_bars" are actually known as "IRON_FENCE" in bukkit
  • There is no limit to how many block types can be used in this list
  • Data values are able to be specified by using a semi-colon ( ";" ), and the data value of the block promptly after. Example: "STONE;1" is Granite
  • Varying types of tools are able to be specified using the sub-categories of the blocklist

Aliases:

  • This is a list value in which blocks can be "linked" to each other to be evaluated as equivalent upon vein mining
  • Every new list element is a new set of aliased blocks. Each line is separate from one another
  • Data values are able to be specified by using a semi-colon ( ";" ), and the data value of the block promptly after. Example: "STONE;1" is Granite
  • An infinite amount of blocks and data values can be aliased with one another
  • Although a block may be listed as an alias, if it is not specified in the block list, it will not be vein minable by any tool, including the player's hand

Comments

Posts Quoted:
Reply
Clear All Quotes