> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/edmobswords/features/enchants.md).

# Sword enchants

The enchants are ordinary EdTools enchants (`plugins/EdTools/enchants/sword-*.yml`): chance, levels, cost, cooldown, prestige, colours, toggles and proc messages all work as described in the EdTools documentation. `/edtools enchant`, `/edtools toolmax`, the upgrade menu and every `%edtools_enchant_*%` placeholder apply.

The 26 animated ones are `type: api` (driven by EdMobSwords) and carry a `settings:` section. Every number in it accepts PlaceholderAPI and math, plus `{damage}` (the sword swing that procced it), `{health}` and `{max-health}` of the mob hit, so effects can scale with the enchant level:

```yaml
settings:
  radius: '4 + %edtools_enchant_level_sword-cleave% / 250'
  damage: '{damage} * 0.8'
```

Delete an enchant's yml to disable it (like EdTools' own api enchants). Move it into a sub-folder to organise it.

| Enchant         | Id                 | What it does                               | Settings                                                                     |
| --------------- | ------------------ | ------------------------------------------ | ---------------------------------------------------------------------------- |
| Coin Greed      | `sword-greed`      | bonus currency on hit, rising reward text  | `currency`, `amount`, `hologram`                                             |
| Critical Strike | `sword-critical`   | a second, heavier blow                     | `damage`                                                                     |
| Executioner     | `sword-execute`    | finishes mobs under a health %             | `threshold-percent`, `color`                                                 |
| Vampire         | `sword-vampire`    | heals you                                  | `hearts`                                                                     |
| Bleed           | `sword-bleed`      | damage over time                           | `ticks`, `interval`, `damage`, `color`                                       |
| Cleave          | `sword-cleave`     | hits the mobs around the target            | `radius`, `max-targets`, `damage`                                            |
| Chain Lightning | `sword-lightning`  | bolt jumps to the nearest mobs             | `jumps`, `jump-distance`, `jump-delay`, `damage`                             |
| Frenzy          | `sword-frenzy`     | faster auto-hit for a while                | `speed-multiplier`, `duration-ticks`                                         |
| Key Finder      | `sword-keyfinder`  | runs EdTools actions (crate keys...)       | `actions`, `hologram`                                                        |
| Loot Magnet     | `sword-magnet`     | coins fly from the mob to you              | `coins`, `currency`, `amount-per-coin`, `coin-item`, `flight-ticks`          |
| Meteor Strike   | `sword-meteor`     | fireball from the sky, area blast          | `radius`, `damage`, `height`, `speed`                                        |
| Frost Nova      | `sword-frost`      | expanding frost ring                       | `radius`, `damage`, `ring-step`, `color`                                     |
| Inferno         | `sword-inferno`    | nearby mobs burn                           | `radius`, `ticks`, `interval`, `damage`                                      |
| Poison Cloud    | `sword-poison`     | lingering toxic cloud                      | `radius`, `duration-ticks`, `interval`, `damage`, `color`                    |
| Thor's Wrath    | `sword-thor`       | lightning on random mobs across the zone   | `bolts`, `bolt-delay`, `splash-radius`, `damage`                             |
| Arrow Turret    | `sword-turret`     | a dispenser turret shoots the nearest mobs | `duration-ticks`, `interval`, `range`, `damage`                              |
| Spirit Wolves   | `sword-wolves`     | wolves sprint from mob to mob              | `wolves`, `bites`, `speed`, `damage`, `entity-name`                          |
| Earthquake      | `sword-quake`      | shockwave rings with debris                | `radius`, `damage`, `debris`                                                 |
| Guardian Beam   | `sword-beam`       | a guardian's laser charges and blasts      | `charge-ticks`, `interval`, `damage`, `final-damage`, `color`, `entity-name` |
| Iron Legion     | `sword-golems`     | iron golems slam the ground                | `golems`, `slams`, `slam-radius`, `speed`, `damage`, `entity-name`           |
| Phoenix         | `sword-phoenix`    | a firebird circles you throwing feathers   | `duration-ticks`, `interval`, `range`, `damage`, `entity-name`               |
| Soul Reaper     | `sword-reaper`     | the reaper appears and swings once         | `damage`, `soul-currency`, `souls`, `entity-name`                            |
| Black Hole      | `sword-blackhole`  | pulls the mobs in and crushes them         | `radius`, `duration-ticks`, `pull-per-tick`, `damage`, `color`               |
| Soul Tornado    | `sword-tornado`    | a whirlwind hunts mobs across the zone     | `duration-ticks`, `speed`, `radius`, `hit-interval`, `damage`                |
| Dragon's Breath | `sword-dragon`     | the Ender Dragon flies over the zone       | `flight-length`, `height`, `breath-width`, `speed`, `damage`                 |
| Supernova       | `sword-supernova`  | charges, then hits everything in range     | `radius`, `charge-ticks`, `damage`                                           |
| Swiftness       | `sword-speed`      | speed effect while holding the sword       | (`type: effect`)                                                             |
| Iron Skin       | `sword-resistance` | resistance effect while holding the sword  | (`type: effect`)                                                             |

Every api enchant also accepts a `sound` key (any Bukkit sound name) and `proc-message`.

## The menu

`plugins/EdTools/guis/sword.yml` is a normal EdTools GUI: each enchant button opens `upgrade-enchant` with `tool-gui sword`. Buttons are gated with `click-requirement: '%edtools_leveling_level_mob-level% >= N'` - raise or remove the requirements as you like. The bottom row links to abilities, skins, crystals, perks and attributes exactly like the pickaxe menu. The perks button runs `/perks` and needs [EdPerks](/p/edmobswords/features/perks.md); remove it if EdPerks isn't installed.

## Your own enchants

Other plugins register sword enchants through the [Enchants API](/p/edmobswords/api/enchants-api.md).

## Config enchants

You can add your own `type: custom` sword enchants with `tool: 'sword-tool'` and an `actions:` section. They proc on every sword hit with the same data; actions like `give-eco`, `message`, `command`, `particle` and `spawn-entity` work, block actions (`break-blocks`) simply do nothing.
