# Ultimine

> A whole vein of ore or a whole tree in one swing, in the shape you pick, plus a right button for crops, soil, logs and paths. Off by default.

Source: https://stygion.eu/docs/keystone/ultimine
Updated: 2026-10-17

The `ultimine` module (`ultimine.toml`) is **off until you turn it on** (`enabled = true`). Then one swing at a block of a vein takes the whole of it — ore, logs, whatever you set.

## How it is mined

- **With Keystone's client half** (the same jar in the player's `mods/`, see [the client half](/docs/keystone/client-half)): hold the ultimine key (*Controls → Keystone Ultimine*, `` ` `` by default) and break a block. While the key is down the server outlines exactly what one swing will take.
- **Without the mod:** a player types `/ultimine toggle` once and crouches while breaking (`crouch.enabled`, on).
- `/ultimine` says how much a player may take and how.

## Shapes

New in 0.2.6. Besides the vein, a swing can take one of FTB Ultimine's six shapes: **shapeless** (the vein), **small tunnel**, **small square** (3x3), **3x3 tunnel**, **mining tunnel** and **escape tunnel** (a staircase down or up the way you look).

- A player picks the shape with the **mouse wheel while the ultimine key is held** (client half, with a hint on the HUD; needs the 0.2.6 client — a 0.2.5 client keeps working, just without the wheel) or with `/ultimine shape <name>`. The choice is kept.
- Tunnels and squares take any block the tool harvests (`shapes.any-block`).
- Which shapes exist is `shapes.allowed`; a lower limit per shape is `shapes.limits`.

## The right button

New in 0.2.6. With the ultimine key held, the right button works on a whole surface instead of one block: it **harvests and replants ripe crops**, **tills**, **strips logs**, **makes paths**, and **places the block in your hand** over the whole surface. It all lives under `right-click.*` and each part can be turned off. Claims and protection hold block by block here too.

## How much, and for whom

- Everybody with `keystone.ultimine` (the `default` group gets it on the first start) takes up to `max-blocks` (32).
- More per group: `limits = ["vip=48", "vip-plus=64"]`, or per permission with `keystone.ultimine.limit.<n>`. Never past 256.
- Which blocks: `blocks` (`#c:ores`, `#minecraft:logs`), `stone` adds stone, `never` leaves some out, `same-as` makes an ore and its deepslate twin one vein. `diagonal` takes corners too, `reach` is how far from the first block a vein may go.

## What it costs

- `hunger-per-block` — hunger for every extra block (0.25 is about one drumstick for 32); never in creative.
- The tool wears per block the way breaking by hand would; `protect-tool` never lets a vein break it.
- `min-food` — no vein at or below this food level, and a vein in progress stops there.
- `require-tool` — only with a tool the block drops for, so a vein always yields something.
- `cooldown` — seconds between two veins (3).

## Where

`worlds.only` and `worlds.never` pick the worlds. Every block is broken the way a swing breaks it, so **FTB Chunks claims, spawn protection, the world border and every protection mod hold block by block**.