> For the complete documentation index, see [llms.txt](https://nexoaddon.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nexoaddon.gitbook.io/docs/mechanics/bigmining.md).

# BigMining

The BigMining mechanic

The BigMining mechanic allows players to break multiple blocks around a target block efficiently, respecting protection rules, unbreakable blocks, and player permissions.

<figure><img src="https://4179595020-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCKPUSq10oq4Caxl6Izvn%2Fuploads%2Fgit-blob-ac4c85214e867bc83402388b804e673313f17e35%2Fbigmining.gif?alt=media" alt="" width="640"><figcaption></figcaption></figure>

{% hint style="info" %}
`radius` and `depth` options are required!
{% endhint %}

### Simple

```yaml
# Example

Mechanics:
  bigmining:
    radius: 2         # The radius of blocks around the destroyed block to break.
    depth: 3          # The depth of blocks to break in the direction of mining.
```

### Switchable

```yaml
# Example

Mechanics:
  bigmining:
    radius: 1
    depth: 3
    switchable: true  # Will switch bigmining mode on right-click
```

### Breaking material whitelist

```yaml
# Example

Mechanics:
  bigmining:
    radius: 1
    depth: 3
    materials:       # List of whitelisted materials
    - STONE
```

### Custom break sound

```yaml
# Example

Mechanics:
  bigmining:
    radius: 1
    depth: 3
    sound: block.stone.break  # Sound played when blocks are broken, defaults to block.stone.break.
                              # Accepts a namespaced key (e.g. minecraft:block.stone.break or namespace:key).
```