Tools

A tool feature is a ready-made behaviour written as a features: entry with its type and a few keys. It sits on an item like an ability does, and an item can mix both:

features:
  - type: area_break
    width: 3
    height: 3
  - type: telekinesis
    experience: true

An item with at least one tool feature is listed under Tools in the admin menu instead of Special items.

Common to every tool

• Tool features work from the main hand only, except magnet.
• They accept the keys of every feature: permission, cooldown, uses, cancel-event. See Special items.
• A use is spent and the cooldown started only when the tool did something. Mining stone with a vein miner, or a prospector with no ore around, spends nothing.
• magnet, telekinesis, auto_smelt and a compressor's or void filter's automatic work never spend uses or start a cooldown.

effects

Every tool takes an effects section of effect lines:

- type: area_break
  effects:
    on-use: ['[SOUND] BLOCK_STONE_BREAK;0.6;0.8']
    on-block-break: ['[PARTICLE] CLOUD;count:3;offset:0.3,0.3,0.3']
    on-place: []

on-use plays on the player once per run; on-block-break and on-place at each block, up to eight blocks per run.

How extra blocks are broken

Every block a tool breaks besides the one the player broke goes through the same path:

1. Inside an ExyliaMines mine, the mine breaks it and handles the drop.
2. Otherwise WorldGuard must allow building there, and a block break event is sent that any protection plugin can cancel.
3. The block drops as if broken by the held tool, so Fortune and Silk Touch apply.

Air, liquids and unbreakable blocks such as bedrock are never broken. Extra blocks count towards a BLOCKS_MINED tracker on the tool.

Breaking

area_break

Breaks the area around the block the player broke.

Looking more than 60° up or down lays the face flat. Use odd sizes: the area spreads size / 2 blocks to each side, so width: 4 breaks 5.

vein_miner

Every vanilla ore counts by default, deepslate variants, nether quartz, nether gold and ancient debris included.

tree_capitator

Starts only on a log. _WOOD and stripped logs are not in the default list.

auto_replant

Replants a crop the player breaks, without taking a seed.

- type: auto_replant
  crops:
    WHEAT: {min-age: 7}
    NETHER_WART: {min-age: 3}

Breaking a crop below min-age is refused, so unripe crops are left standing. Without crops it handles wheat, carrots, potatoes (7), beetroots and nether wart (3), cactus and sugar cane (0). It also replants crops an area_break on the same item breaks.

Farming

till

width (3) × depth (3) of dirt, grass and paths turned into farmland on a right-click — coarse and rooted dirt into dirt. A short plant on top does not stop it.

seed_planter

Right-clicking farmland plants on every free farmland in width (3) × depth (3), taking one seed each from the player's inventory: wheat seeds, carrots, potatoes, beetroot seeds, melon and pumpkin seeds. Stops when they run out. Special items are never used as seed.

bonemeal_area

Uses no bone meal.

Blocks and liquids

crowbar

Pries blocks out as items.

- type: crowbar
  materials:
    SPAWNER: 1
    END_PORTAL_FRAME: 12
  no-uses-message: '%prefix% {error}This crowbar cannot pry %material% any more.'
  on-no-uses: ['[SOUND] ENTITY_ITEM_BREAK;1;1']

Each material wears out on its own: SPAWNER: 1 pries one spawner. A spawner keeps its mob. The item drops at the block. When every material is spent the crowbar breaks. %uses_<material>% (e.g. %uses_spawner%) shows what is left in the lore.

infinite_bucket

WATER and LAVA place a source — or fill every air block of the area — on the clicked face. Water is refused in the Nether. EMPTY removes every water and lava source in the area around the source it looks at, and fills nothing.

The bucket has a built-in 1-second cooldown of its own, which wins over the item's cooldown:. To change it, write cooldown: on the feature.

Collecting

magnet

While the item is in either hand, once a second, pulls dropped items within radius (8) the player can see towards them at speed (0.4).

telekinesis

Drops go straight into the inventory; what does not fit stays on the ground.

Applies to the block the player broke and to the extra blocks of the item's other tools.

auto_smelt

Drops are smelted with the server's furnace recipes. ignore lists materials left as they drop. Gives no furnace experience.

Without telekinesis on the same item, mob drops are smelted too: killing a cow gives cooked beef.

prospector

On a right-click, marks the nearest matching blocks with mark, seen only by the user, and says "Marked N veins" — N counts blocks. Nothing found spends nothing.

Carried tools

compressor and void_filter work while the item is anywhere in the inventory, not only in the hand.

Automatic mode is on when the item is given. The inventory is checked within a second of a change — picking up, clicking, dropping — and every five seconds otherwise.

compressor

- type: compressor
  every: 3
  recipes:
    - {input: DIAMOND, input-amount: 9, output: DIAMOND_BLOCK, output-amount: 1}

A pass runs the recipes up to eight times, so one recipe's output can feed the next. An input matches only an identical item. %recipes% shows the recipe count.

Compressing happens in place: inputs are taken from their slots and the results are put back in the inventory within stack limits; nothing is dropped or queued for later. When the results would not fit, nothing changes and a right-click answers "No room in your inventory for the compressed items." (tools.compressed-no-room).

void_filter

items: — materials, resource-pack item ids (as in compressor) or exact items. While on, picking up a listed item is refused and the item on the ground is deleted. A right-click deletes every listed stack already in the inventory; special items are never touched. %filtered% shows the list's size.

In-game editors

The admin item screen has an editor button for each compressor and void_filter on the item:

• Recipes — a list of rows. Adding one asks for what is spent (put in the whole cost: the stack you place sets input-amount) and then what it becomes.
• Filter — drop in the items to filter.

Saving writes the feature back into the item file and reloads the items. The file is rewritten as a whole, so its formatting may change.