> For the complete documentation index, see [llms.txt](https://rareitemhunter.gitbook.io/rareitemhunter-remaster/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rareitemhunter.gitbook.io/rareitemhunter-remaster/configuration/rare-catalog.md).

# Rare Catalog

This page describes the built-in rare properties included in the current codebase.

## Property Types

The plugin groups rares into these functional types:

| Type          | Typical Base Items                   |
| ------------- | ------------------------------------ |
| `SKILL`       | Bows, swords, and axes               |
| `ENCHANTMENT` | Pickaxes, hoes, and shovels          |
| `SPELL`       | Books                                |
| `ABILITY`     | Armor pieces and some wearable items |
| `VISUAL`      | Helmet-style visual items            |

Notes:

* `Hardy` is more restrictive than normal abilities and only applies to chestplates.
* Custom item systems can provide a compatible base type through the external item bridge.

## SKILL

| Property               | Description                                             |
| ---------------------- | ------------------------------------------------------- |
| `Poison`               | Poisons the target on hit                               |
| `Backstab`             | Deals more damage when striking from behind             |
| `Blinding`             | Has a chance to blind the target                        |
| `CallLighting`         | Has a chance to trigger a lightning-based strike effect |
| `Confuse`              | Has a chance to confuse the target                      |
| `Disarm`               | Has a chance to disarm the target                       |
| `Slow`                 | Has a chance to slow the target                         |
| `VampiricRegeneration` | Has a chance to steal health from the target            |
| `Weaken`               | Has a chance to weaken the target                       |
| `Execute`              | Deals extra damage to low-health targets                |
| `Bleed`                | Applies armor-piercing damage over time                 |

## ENCHANTMENT

| Property       | Description                              |
| -------------- | ---------------------------------------- |
| `Fertilize`    | Converts dirt into grass                 |
| `MeltObsidian` | Converts lava into obsidian              |
| `Smelt`        | Smelts eligible block results directly   |
| `Spore`        | Converts cobblestone into mossy variants |
| `VeinMiner`    | Breaks entire ore veins at once          |
| `TreeFeller`   | Fells full tree trunks from one break    |

## SPELL

| Property         | Description                                  |
| ---------------- | -------------------------------------------- |
| `Burst`          | Pushes an enemy away                         |
| `CraftItem`      | Opens a crafting table                       |
| `FireResistance` | Grants fire resistance                       |
| `GreaterBurst`   | Pushes multiple nearby enemies               |
| `Haste`          | Grants speed                                 |
| `Invisibility`   | Grants invisibility                          |
| `MagicBag`       | Opens an Ender Chest                         |
| `RepairItem`     | Repairs the item in the first inventory slot |

## ABILITY

| Property       | Description                                   |
| -------------- | --------------------------------------------- |
| `Durability`   | Repairs equipped armor automatically          |
| `Regeneration` | Grants passive health regeneration            |
| `NoFallDamage` | Reduces fall damage by level                  |
| `DoubleJump`   | Grants extra mid-air jumps                    |
| `Fly`          | Allows flight while its cost can be sustained |
| `Hardy`        | Grants bonus max health per level             |

## VISUAL

| Property | Description                        |
| -------- | ---------------------------------- |
| `Flame`  | Cosmetic flame-style visual effect |

## Costs, Levels, and Cooldowns

Each rare can define:

* `useCost`
* `maxLvl`
* `cooldownSeconds`
* `recipe`

These are configured in `rares.yml`.

## Disable a Rare Completely

Set:

```yaml
useCost: -1
```

When set to `-1`, the property is not registered for gameplay.
