Tools

A tool is the heart of the plugin. Each tool earns currency from its own action, then spends it in the tool's menu.

Supported tools

Tool	Default material	Earns from	Minimum version
Pickaxe	Netherite Pickaxe	Breaking blocks	1.18
Axe	Netherite Axe	Chopping logs	1.18
Shovel	Netherite Shovel	Digging blocks	1.18
Hoe	Netherite Hoe	Harvesting crops	1.18
Sword	Netherite Sword	Killing mobs	1.18
Fishing Rod	Fishing Rod	Catching fish	1.18
Trident	Trident	Killing mobs	1.18
Mace	Mace	Killing mobs	1.21
Spear	Netherite Spear	Killing mobs	1.21.11

A tool whose material does not exist on your server version is skipped automatically. So the mace and spear simply do not load on older servers. You can also turn any tool off with the enabled flag in its file.

Each tool's material, currency name, earn rates, enchants, and effects live in its own file under tools/. The pickaxe.yml file has the full schema documentation, and the other files point back to it.

How earning works

Every tool has an earn-from list. The list maps an action to a currency amount. You stay in full control of the economy.

A pickaxe can pay one amount for stone and a bigger amount for diamond ore.
A sword pays per mob type.
A fishing rod pays per caught item.
Anything not on the list pays nothing.

Player does the action

They break a block, kill a mob, or catch a fish that is on the earn-from list.

Currency is added

A short gain message appears. It shows on the action bar or in chat, set by display.use-action-bar-on-gain.

The balance is saved

The new balance is stored on the item and shown in the tool's lore and menu.

What the lore can show

The lore can list more than the balance. Each part below is turned on or off with a display.lore-show-... option in config.yml.

The tool's enchant levels.
The live bonus of upgradable effects, shown as a percentage. For example, a currency multiplier at +25%.
The settings, with each on/off toggle as a green check or red cross, plus the active mining radius.

The settings part of the lore updates the moment a toggle is flipped in the menu, so the held item always matches.

Upgrading a tool

While holding a tool, sneak and right-click to open the menu. From there a player can:

Buy Enchantments with the tool's balance.
Unlock and upgrade Effects like autosmelt or radius mining.
Toggle effects and pick a mining radius under Settings.
Track the Quests for that tool.
Open the server Leaderboards.

See Menus for a tour of each page.

Customizing enchants

You decide which enchants a tool offers. Open the tool file, find the enchants block, and add an entry. Each entry needs a max-level and a cost-curve (one price per level, so the list length matches max-level).

enchants:
  EFFICIENCY:
    max-level: 10
    cost-curve: [500, 1000, 2000, 4000, 8000, 16000, 32000, 64000, 128000, 256000]
  UNBREAKING:
    max-level: 3
    cost-curve: [5000, 15000, 50000]

A new entry shows up in the enchant menu and the tool lore on the next /et reload.

Use real Minecraft enchant names that fit the tool (for a sword: SHARPNESS, SMITE, LOOTING, FIRE_ASPECT, SWEEPING_EDGE, and so on). A name the game does not know will appear in the menu but apply nothing to the item.

The enchants list and the currency earn-from list are yours to edit. The plugin keeps them exactly as you write them across reloads and updates, so entries you add are never wiped. Buying is always done in the enchant menu; the lore only displays the levels you own.

Progress is saved on the item

A tool's currency, enchants, effects, settings, and quest progress all live on the item. The tool keeps everything through death, dropping, trading, and server restarts.

The server also keeps a backup of each tool in the database, so an admin can restore a lost one with /et restore.

Tools

On this page