Mystic Tools

Mystic Tools adds tools with abilities: a drill that mines 3x3, an axe that fells a whole tree, an axe that sells the contents of chests it breaks, a hoe that harvests and replants a 3x3 of crops, buckets and pearls that never run out. Every tool is an item you define in config.yml, so you pick the material, name, lore, enchantments and which abilities it carries.

Tools can be handed out permanently or with a self-destruct timer, which makes them work well as crate rewards and store items.

Permissions#

Commands#

Configuration#

config.yml holds everything except the license key.

Defining a tool#

Each entry under built-in-items is one tool. The key (amethyst-drill below) is the name you use in /mythictool give.

built-in-items:
  amethyst-drill:
    type: 'NETHERITE_PICKAXE'
    name: '&#b466dfᴀᴍᴇᴛʜʏsᴛ ᴅʀɪʟʟ'
    enchantments:
      MENDING: 1
      UNBREAKING: 3
      EFFICIENCY: 5
    abilities:
      - drill

Optional keys: lore (a list of lines), unbreakable: true, custom-model-data (a number, for resource packs) and potion-type for potions. The default config ships a multitool, tree chopper, sell axe, magic hoe, drill, shovel (a drill on a shovel), water and lava buckets, ender pearl, two fireworks and a shard booster.

Other options#

Every message sits under messages, each with enabled, a type (chat or actionbar), the text and an optional sound.

Update alerts#

Staff with blazez.updates (OPs by default) get one chat message when they join, listing every installed BlazeZ plugin that has an update waiting. It stays off until you set check-for-updates: true in this plugin's license.yml.

Install#

1. Put the jar in plugins/ and start the server once. Mystic Tools creates plugins/MythicTools/ with config.yml and license.yml.
2. Paste your license key into license-key in license.yml. Your key is under My Licenses on the BlazeZ portal; licenses linked to your Discord account show up there automatically. If yours is missing, open a License Key ticket in the BlazeZ Discord.
3. For the sell axe and magic hoe, install a supported shop plugin (see Selling). Without one, those two abilities stay off.
4. Restart the server, then give yourself a tool with /mythictool give <player> <tool>.
5. After editing config.yml, run /mythictool reload.

Abilities#

A tool's abilities list decides what it does. One item can carry several abilities.

Ability tools never stack, so each keeps its own timer and ability. No ability works in a world from blacklisted-worlds (default Spawn) or on a block from blacklisted-blocks (default OBSIDIAN).

Tools respect protection. In a WorldGuard region or a Lands, GriefPrevention, HuskClaims or ProtectionStones claim where the player can't build, the ability doesn't fire and the player gets the lands-protection message.

Drill#

drill-break-mode sets the shape:

• Custom (default) breaks a full 3x3x3 cube.
• DonutSMP breaks a flat 3x3 facing the direction you mine in.

Each use costs drill-break-durability durability (default 1), and drill-particles shows break particles.

Tree chopper#

Breaking one log fells every connected log, wood, stem and hyphae block. It looks through leaves to find logs on the other side of them, so branches come down too. Leaves stay unless tree-chopper-break-leaves is true. tree-chopper-max-blocks (default 512) caps one swing, so a giant tree can't cause a lag spike.

Magic hoe#

When the player breaks a fully grown crop, every grown crop in the 3x3 around it is harvested and replanted for free, and the drops are sold. Works on wheat, carrots, potatoes, beetroots and nether wart.

Auto pickup#

With autopickup-broken-blocks: true, blocks from the drill and tree chopper go straight into the player's inventory. When it's full, the rest drops at the block. Off by default.

Skill and job plugins#

Every block a drill, tree chopper or magic hoe clears counts as a real block break. Jobs, mcMMO, AuraSkills and loggers like CoreProtect see each block, as if the player had broken it by hand.

Selling#

The sell and magic-hoe abilities sell through a shop plugin, using that plugin's prices. By default Mystic Tools picks the first one it finds, in this order:

1. EconomyShopGUI or EconomyShopGUI-Premium
2. DonutUtils (with Vault)
3. UltimateShop
4. ShopGUIPlus
5. Essentials, using the prices in worth.yml and each player's sell multiplier
6. CuyModern or EconomyModern (with Vault), using worth.yml

To force one, set priority-shop to its name, for example ShopGUIPlus. The console prints the shop it picked on startup.

The sell axe sells the contents of any chest it breaks, and the player gets money instead of items. Other blocks broken with it drop normally unless sell-ability-per-block is true, in which case their sellable drops are sold and the rest drop.

Self-destructing tools#

Add a duration at the end of the give command to make a tool that deletes itself when time runs out:

/mythictool give Steve amethyst-drill 3d2h30m

The remaining time is written into the tool's lore using self-destruct.lore (%time-left% is the countdown) and updates every self-destruct.refresh-time-in-seconds (default 60).

By default the timer keeps running wherever the tool is. pause-while-stored stops it in the places you turn on:

self-destruct:
  pause-while-stored:
    auction: true
    chest: false
    ender-chest: false
    player-vault: false

chest covers chests, barrels and shulker boxes, and player-vault covers PlayerVaults. For auction, a listing made with a command in auction-sell-commands (such as ah sell) is detected on any auction plugin. For auction plugins that list through a menu, add that menu's title to auction-gui-titles. AuctionHouse and zAuctionHouseV3 are detected without either list.

/mythictool maintenance on freezes every self-destruct timer on the server at once, including tools in chests and offline players' inventories. /mythictool maintenance off resumes them where they stopped. Use it during downtime so players don't lose time they couldn't play. The state survives restarts.

Shard booster#

With the Shards plugin installed, the shard-boost ability turns a potion into a booster. Using it gives the player a booster-multiply shard multiplier (default 4) for booster-time (default 24h). A player can only have one booster at a time, and /booster shows the multiplier and time left.

Placeholders#

Set placeholderapi.enabled: true and install PlaceholderAPI. Every placeholder reads the tool in the player's main hand.

Developer API#

me.blazezstudio.minecraft.api.event.ToolAbilityTriggerEvent fires right before a drill, tree chopper, sell, magic hoe, ender pearl or bucket ability runs, after the world, region and claim checks. It is cancellable: cancelling it skips the ability, so the block breaks like it would with a normal tool.

Getters: getPlayer(), getTool() (the ItemStack), getAbilityName() (drill, tree-chopper, sell, magic-hoe, ender-pearl, water-bucket, lava-bucket) and getBlock() (null for the ender pearl).

@EventHandler
public void onAbility(ToolAbilityTriggerEvent event) {
    if (event.getAbilityName().equals("drill") && inSafeZone(event.getPlayer())) {
        event.setCancelled(true);
    }
}

Add softdepend: [MythicTools] to your plugin.yml.

Troubleshooting#

• The sell axe or magic hoe does nothing: no supported shop plugin was found. Check the Using shop hook line in the console on startup.
• A tool works everywhere except spawn: Spawn is in blacklisted-worlds by default.