# Hytale

# Hytale Mods

Welcome to the official documentation for all KyuubiSoft Hytale server mods.

Every version of our free mods (Core, Achievements, Quests and Info Hub), stable and beta, is on the [Downloads](https://wiki.kyuubisoft.com/hytale/downloads/) page.

---

## Released Mods

### CurseForge

| Mod | Description | Version | Link |
|-----|-------------|---------|------|
| [Core](https://wiki.kyuubisoft.com/hytale/core/) | NPCs with in-game editors, NPC shops, `/ksadmin` hub, KS settings, tracking, localization, web editor | `2.9.9` | [CurseForge](https://www.curseforge.com/hytale/mods/kyuubisoft-core) |
| [Achievements & Titles](https://wiki.kyuubisoft.com/hytale/achievement-system/) | 432 achievements, about 340 titles, achievement book, admin window, HUD tracker | `3.1.6` | [CurseForge](https://www.curseforge.com/hytale/mods/kyuubisoft-achievements-titles-rewards) |
| [Quest System](https://wiki.kyuubisoft.com/hytale/quest-system/) | Story chapters, daily/weekly pools, NPC dialogs, Questbook, admin window, token shop | `2.1.8` | [CurseForge](https://www.curseforge.com/hytale/mods/kyuubisoft-quest-system-story-daily-weekly-quest) |
| [Info Hub](https://wiki.kyuubisoft.com/hytale/info-hub/) | Info book with news, commands, rules, FAQ, team, custom pages, admin window | `3.1.5` | [CurseForge](https://www.curseforge.com/hytale/mods/kyuubisoft-info-hub-commands-faq-team-own-item) |

### BuiltByBit

| Mod | Description | Version | Link |
|-----|-------------|---------|------|
| [Bank](https://wiki.kyuubisoft.com/hytale/bank/) | Item vault with pages, search, coin deposits, transfers, history, admin panel | `2.6.6` | [BuiltByBit](https://builtbybit.com/resources/kyuubisoft-item-economy-bank.95274/) |
| [Item Control](https://wiki.kyuubisoft.com/hytale/item-control/) | 14 modules: crafting, drops, drop prevention, soulbound, death rules, overrides | `3.0.1` | [BuiltByBit](https://builtbybit.com/resources/kyuubisoft-full-item-control.96484/) |
| [Companions (Pets)](https://wiki.kyuubisoft.com/hytale/pets/) | 26 pickup pets, 13 combat pets, 9 mounts; compendium with live 3D preview, admin window | `1.12.5` | [BuiltByBit](https://builtbybit.com/resources/kyuubisoft-companions.95816/) |
| [VoiceHub](https://wiki.kyuubisoft.com/hytale/voicehub/) | Voice channels, proximity, whisper, moderated, talk power | `2.0.2` | [BuiltByBit](https://builtbybit.com/resources/kyuubisoft-voicehub.96480/) |
| [Graveyard](https://wiki.kyuubisoft.com/hytale/graveyard/) | Gravestones on death, custom designs, particles, item loss | `2.1.1` | [BuiltByBit](https://builtbybit.com/resources/kyuubisoft-graveyard.95448/) |
| [Season Pass](https://wiki.kyuubisoft.com/hytale/season-pass/) | Battle pass with tiers, challenges, token shop, prestige, XP boosters, HUD tracker | `2.0.7` | [BuiltByBit](https://builtbybit.com/resources/kyuubisoft-seasonpass.95386/) |
| [Dropable Lootbags](https://wiki.kyuubisoft.com/hytale/lootbags/) | 150 collectible lootbags (30 styles, 5 tiers), mob/block drops, catalog, admin panel | `2.0.4` | [BuiltByBit](https://builtbybit.com/resources/kyuubisoft-dropable-lootbags.99744/) |

### Other

| Mod | Description | Version | Link |
|-----|-------------|---------|------|
| [Player Shops](https://wiki.kyuubisoft.com/hytale/player-shops/) | Player-run merchant shops, server shops, marketplace, rental stands, mailbox, admin window | `2.0.6` | — |

---

## Under Development

Documented already, but still under development and not tested in game yet:

| Mod | Description | Version | Status |
|-----|-------------|---------|--------|
| [Heirlooms](https://wiki.kyuubisoft.com/hytale/heirlooms/) | Weapons, bows, tools and shields with a story: fame, titles, chronicle, hall of fame, optional boons and banes, admin window | `1.0.1` | Under Development |
| [Whisperstone](https://wiki.kyuubisoft.com/hytale/whisperstone/) | Crystal carried like a phone: messages, farcalls across worlds, companions, star map, runes for other KS mods | `1.0.3` | Under Development |
| [Guilds](https://wiki.kyuubisoft.com/hytale/guilds/) | Guilds with ranks and rights, locked chests and doors, guild levels, shared storage, guild homes, admin window | `1.0.0` | Under Development |
| [Claims](https://wiki.kyuubisoft.com/hytale/claims/) | Land claimed on a map with the terrain of the world map, roles and a rights table, zones, server zones, homes and an admin window | `2.0.0` | Under Development |
| [Server Events](https://wiki.kyuubisoft.com/hytale/events/) | Event calendar with build contests and meetings: sign-up, reminders, travel, plots on a build field, voting, ceremony, rewards, admin window | `1.0.0` | Under Development |
| [Order Board](https://wiki.kyuubisoft.com/hytale/orders/) | Buy requests for the whole server: rewards held in escrow, partial deliveries, guild and direct orders, pickup box, admin window | `1.0.0` | Under Development |
| [Kronen](https://wiki.kyuubisoft.com/hytale/core/kronen/) | Server currency in Core `2.10.0` and Bank `2.7.0`: off by default, `/kskronen`, payments with reasons, admin window with accounts and log | `2.10.0` | Under Development |

---

## Unreleased / Coming Soon

These mods are documented but not yet publicly available:

| Mod | Description | Status |
|-----|-------------|--------|
| [KS Nameplates](https://wiki.kyuubisoft.com/hytale/nameplates/) | Custom nameplate system with formatting and admin panel (`1.2.4`) | In Development |
| [KS Dungeons](https://wiki.kyuubisoft.com/hytale/dungeons/) | Dungeon maps, arenas, stones and bosses (`4.4.5`) | In Development |

:::info
Unreleased mods have documentation available for preview, but features may change before release.
:::

---

## Tools

| Tool | Description | Version |
|------|-------------|---------|
| [Panel](https://wiki.kyuubisoft.com/hytale/panel/) | Web-based server management panel with Docker | `2.1.3` |
| [Mod Editor](https://modeditor.kyuubisoft.com/) | Browser-based quest, NPC, shop, and lootbag editor | Web App |

---

## Core System Overview

The **KyuubiSoft Core** mod is the shared foundation. It provides:

| System | Description | Wiki |
|--------|-------------|------|
| [Citizens & NPCs](https://wiki.kyuubisoft.com/hytale/citizens/) | NPC spawning, skins, dialogs and dialog actions, animations, waypoints, world map markers, in-game admin windows | [Docs](https://wiki.kyuubisoft.com/hytale/citizens/) |
| [Shop System](https://wiki.kyuubisoft.com/hytale/shop-system/) | NPC buy/sell shops (`/ksnpcshop`) with multiple currencies, daily rotation and an in-game shop editor | [Docs](https://wiki.kyuubisoft.com/hytale/shop-system/) |
| [Lootbag Templates](https://wiki.kyuubisoft.com/hytale/achievement-system/lootbags) | Simple reward containers for achievements/quests (built into Core) | [Docs](https://wiki.kyuubisoft.com/hytale/achievement-system/lootbags) |
| [Tracking System](https://wiki.kyuubisoft.com/hytale/tracking/) | Block, kill, craft, distance, zone tracking for achievements/quests/season pass | [Docs](https://wiki.kyuubisoft.com/hytale/tracking/) |
| [Developer Tools](https://wiki.kyuubisoft.com/hytale/dev-tools/) | Data export, web config editor, debug commands | [Docs](https://wiki.kyuubisoft.com/hytale/dev-tools/) |

---

## How Mods Connect

```
                    ┌─────────────┐
                    │    Core     │
                    │ NPCs, Shops │
                    │  Tracking   │
                    │ Loot Tmpl.  │
                    └──────┬──────┘
                           │
              ┌────────────┼────────────┐
              │            │            │
         ┌────▼──┐     ┌───▼──┐     ┌───▼──┐
         │Quests │     │Achiev│     │Season│
         │       │     │ments │     │ Pass │
         └───────┘     └──────┘     └──────┘

  Standalone (Core optional: /ksadmin tile, /kssettings, web editor):
     ┌────────┐ ┌──────────┐ ┌─────────┐ ┌────────┐ ┌────────┐ ┌──────┐ ┌────────┐
     │  Bank  │ │Item Ctrl │ │Graveyard│ │VoiceHub│ │Lootbags│ │ Pets │ │Info Hub│
     └────────┘ └──────────┘ └─────────┘ └────────┘ └────────┘ └──────┘ └────────┘
```

- **Core** provides NPC citizens, shops, tracking, lootbag reward templates, and localization
- **Quests** uses Core for NPC dialogs, tracking events, and the token shop
- **Achievements** uses Core for tracking events and lootbag rewards
- **Season Pass** uses Core for XP tracking, challenge progress, and the shop
- **Info Hub** works standalone; with Core it adds its tile to the `/ksadmin` hub, a `/kssettings` page, the web editor and NPC links
- **Pets** works standalone; with Core installed, new config keys are merged into an existing `config.json` automatically and the admin window gets a tile in the `/ksadmin` hub
- **Dropable Lootbags** is a standalone mod — separate from Core's lootbag reward templates
- **Bank, Item Control, Graveyard, VoiceHub, Lootbags** work standalone (Core optional)
- With Core 2.8 or newer, every installed KS mod shares one language choice (`/kslang`, `/kssettings`) and shows up in the `/ksadmin` hub

---

## Requirements

- Hytale server 0.7.x (the current releases are built against Hytale 0.7.0)
- Java 25 or higher
- Docker & Docker Compose (for Panel only)

## Support

- [Discord](https://dc.gg/kyuubisoft) — Community and support
- [GitHub](https://github.com/KyuubiDDragon) — Source and issue tracking