# Introduction

ArefyDungeons is a **incremental dungeon mob plugin** for Minecraft servers running Paper 1.20+. Players fight packet-based mobs in customizable dungeon zones, upgrade enchantments, collect currencies, and progress through 240 stages across 24 themed zones.

Everything is configurable through YAML files (Zones, mobs, enchantments, currencies, GUIs, and more). No hardcoded content.

<sup>*Inspired by the dungeon systems of EnchantedMC, FadeCloud, OPLegends...*</sup>

<figure><img src="https://3358500977-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9M0v9RUPjNROKxHPscZp%2Fuploads%2FYgjvQJ0JtjWv6HfY1xWZ%2FDiscord_1MML231nAGonline-video-cutter.com-ezgif.com-video-to-gif-converter.gif?alt=media&#x26;token=9c12d1ac-6ad7-4077-a796-c25f963c15d8" alt=""><figcaption></figcaption></figure>

***

## Features

* **24 Dungeon Zones** with 10 stages each (240 total stages), from Barn to Mythic
* **Packet-based mobs** — per-player visibility using PacketEvents, zero server entities
* **73 Enchantments** with a powerful YAML action engine — spawn entities, particle beams, projectiles, loops, damage formulas, and more
* **14 Currencies** — money, souls, essence, shards, credits, sword-xp, rebirth points, and upgradeable stats
* **OmniTool System** — a NETHERITE\_SWORD with dynamic lore showing all enchant levels
* **AutoFighter** — an NPC clone with your skin that fights mobs for you while you AFK
* **Heroes** — Companions (Archer Queen, Barbarian King) that auto attack mobs with many enchantment upgrades
* **Leveling** — Sword Level + Rebirth prestige system with exponential costs
* **Boss Bars** — packet-based health bars per mob with color thresholds
* **Damage & Reward Holograms** — floating text showing damage dealt and rewards earned
* **Powerups** — global timed powerups that spawn in zones and boost currencies/enchants
* **GUIs** — fully YAML-configurable inventory menus with click actions
* **PlaceholderAPI** — 80+ placeholders for scoreboards, holograms, and TAB
* **RivalPets Integration** — currency boost, enchant boost, and XP on mob hit
* **Vault Integration** — any currency can be linked to Vault
* **Developer API** — 55 methods for external plugins to interact with all systems

***

## Installation

1. Download **ArefyDungeons.jar** and place it in your `plugins/` folder
2. Install **PacketEvents** (required dependency) in `plugins/`
3. Install **PlaceholderAPI** and **NBTAPI** (optional but recommended for placeholders)
4. Start your server, the plugin will generate default configuration files
5. Stop the server
6. Open `plugins/ArefyDungeons/config.yml` and add your license key:

```yaml
license-key: 'YOUR-LICENSE-KEY-HERE'
```

7. Start the server again — the plugin will validate your license and enable

> **Don't have a license key?** Open a ticket at [discord.nekiosetups.com](https://discord.nekiosetups.com) to purchase one.