# KS Dungeons

# KS Dungeons

:::caution[In development]
KS Dungeons is not publicly released yet. This page describes the current development build (4.4.3). Features and names can still change before release.
:::

KS Dungeons turns **dungeon maps** into runs. Mobs in the open world sometimes drop a dungeon map. Using the map opens a fresh **open-arena dungeon** of the map's biome, size and difficulty: clear the surface, fight through the caves, then beat the bosses. Maps can be improved with **crafting stones** or combined into rarer maps.

**Main Command:** `/ksdungeon` (Aliases: `dungeon`, `dg`)

---

## How it works

1. **Find a map.** Regular mobs in the open world drop a dungeon map with a small chance (5 % by default). Each map has a biome, a rarity (Common to Legendary), a level, a quality (1–100 %), an arena size and shape, and up to five modifiers.
2. **Improve it (optional).** Crafting stones drop from mobs too (2 % by default). They re-roll, add or remove modifiers, upgrade the rarity or change the biome. Three maps of the same rarity can be combined into one map of the next rarity.
3. **Open the dungeon.** Right-click the map, or pick it in the maps window (`/ksdungeon maps`) and press **Open Dungeon**. The map is used up.
4. **Clear the arena.** A run has three stages: **surface** mobs, a **cave** wave underground, and the **bosses** at the center. The team shares a pool of lives; a death costs one life and you respawn automatically.
5. **Rewards.** Finishing a run shows time, deaths, score and rank in chat and gives dungeon tokens. Bosses always drop boss-tier maps (one per party member), which are never Common.

---

## Features at a Glance

### Biomes

Six biomes ship with the mod, each with its own terrain, mob pool, bosses and structures:

| Biome | ID |
|-------|----|
| Stone Caves | `stone_caves` |
| Forest Ruins | `forest_ruins` |
| Desert Tombs | `desert_tombs` |
| Frozen Crypts | `frozen_crypts` |
| Lava Depths | `lava_depths` |
| Void Sanctum | `void_sanctum` |

### Map rarity and difficulty

The rarity of a map sets the run's difficulty and how many modifiers it can carry:

| Rarity | Difficulty | Max modifiers |
|--------|-----------|---------------|
| Common | Easy | 1 |
| Uncommon | Normal | 2 |
| Rare | Hard | 3 |
| Epic | Heroic | 4 |
| Legendary | Heroic | 5 |

### Modifiers

Prefixes make a run harder, suffixes improve the rewards. Values scale with the map's quality.

- **Prefixes:** Monster Damage, Monster Life, Monster Speed, Monster Attack Speed, Reduced Time, Reduced Healing
- **Suffixes:** Item Quantity, Item Rarity, Experience, Stone Drops, Monster Count, Elite Chance

See [Mechanics](./mechanics) for which modifiers already have an effect.

### Crafting stones

Chaos, Regal, Cartographer, Alchemy, Scour, Mirror, Annul and Exalt stones change a map. See [Mechanics](./mechanics#crafting-stones).

### Windows and HUD

- **Dungeon browser** (`/ksdungeon open`) — pick a biome, a difficulty and start a run without a map
- **Maps window** (`/ksdungeon maps`) — your maps in a grid with details, stone application and map combining
- **Dungeon HUD** during a run
- Optional hover tooltips for maps and stones with DynamicTooltipsLib

---

## Requirements

- Hytale Server 0.7.x (built against 0.7.0)
- Java 25
- **KyuubiSoft Core** (Update 7 build)
- Optional: KyuubiSoft Achievements (dungeon achievement triggers)
- Optional: DynamicTooltipsLib (map and stone hover tooltips)