Skip to content

Configuration

C4 edited this page Jan 25, 2022 · 8 revisions

Vein Mining is designed to be highly configurable, allowing users and modpack developers to tailor the behavior towards their own preferences and sense of balance within the ecosystem.

Location

Forge:

Server*: veinmining-server.toml in serverconfigs in the world save

Client: veinmining-client.toml in config in the root

*Note: Server configuration files can be placed in defaultconfigs in the root in order to provide default settings for all newly created worlds.

Fabric:

Universal: veinmining.json5 in config in the root

Configuring Activation Method

The configuration option for the activation method (how the player activates vein mining when all other conditions are met) is located in the config folder's configuration file, veinmining-client.toml for Forge or veinmining.json5 for Fabric.

Possible Values:

  • "STANDING" - Vein mining is active as long as the player is standing straight
  • "CROUCHING" - Vein mining is active as long as the player is crouching
  • "KEYBINDING" - Vein mining is active as long as the associated keybinding (found in the Controls menu) is held down

Configuring Blocks

The configuration option for blocks is located in the world save's serverconfig folder's configuration file, veinmining-server.toml for Forge or the config folder's configuration file, veinmining.json5 for Fabric.

The two most important configuration options for configuring blocks are the blocks list and the blocksPermission setting.

blocksPermission

This determines whether the blocks list is a whitelist or a blacklist. A whitelist means that only those blocks can be vein mined. A blacklist means that only these blocks cannot be vein mined.

blocks

This is a list of blocks that are whitelisted/blacklisted according to the above blocksPermission setting. The format is modid:name. Tags in the format of #modid:tag are also acceptable.

Popular Settings

Works Without Enchantment

Forge:

maxBlocksBase = 50
maxDistanceBase = 15

Fabric:

"maxBlocksBase": 50,
"maxDistanceBase": 15

Ores Only

Forge:

blocks = ["#forge:ores"]
blocksPermission = "WHITELIST"

Fabric:

"blocks": ["#c:ores"],
"blocksPermission": "WHITELIST"

Trees Only

Forge:

blocks = ["#minecraft:logs"]
blocksPermission = "WHITELIST"

Fabric:

"blocks": ["#minecraft:logs"],
"blocksPermission": "WHITELIST"

Configuring Items

Items that can be enchanted are configurable. Entries are normally based on the registry name of the item, such as minecraft:diamond_pickaxe.

However, there are special entries that you can use to denote classifications of items. Currently, these special entries are:

  • is:tool - All items that are considered tools
  • is:pickaxe - All items that are considered pickaxes
  • is:shovel - All items that are considered shovels
  • is:axe - All items that are considered axes
  • is:hoe - All items that are considered hoes

An example of a configuration that allows all tools and the Quark Pickarang to be enchanted with Vein Mining:

items = ["is:tool", "quark:pickarang"]