Mob Configuration

---

Overview

Ideally, your mobs should be organized into their own folder for better readability. But it is your choice. Below is an example of good organisation.

/plugins/PhantomDungeons/mobs/
  ├─ barn/
  │  ├─ chicken/
  │  │  ├─ chicken-common.yml
  │  │  ├─ chicken-rare.yml
  │  │  ├─ chicken-unique.yml
  │  │  └─ chicken-legendary.yml
  │  ├─ cow/
  │  └─ skeleton/
  └─ sea/
     └─ (your custom mobs)

---

Quick Start

1

Create a Mob File

Create a new .yml file in the appropriate zone folder:

/mobs/barn/chicken/chicken-epic.yml

2

Configure Basic Properties

Set the entity type, health, and display name

3

Add Visual Effects

Configure glow, boss bar, and damage indicators

4

Set Rewards

Define what players receive when killing the mob

5

Customize Appearance (Optional)

Add armor, equipment, and entity-specific variants

---

Documentation Sections

Basic Configuration

Entity properties, health, and auto-hit settings

Visual Settings

Glow effects, boss bars, and damage indicators

Rewards System

Currency, commands, and hologram configuration

Entity Metadata

Armor, equipment, variants, and customization

Examples

Complete working mob configurations

---

Basic Structure

Every mob file follows this structure:

mob-template.yml

# ───────────────────────────────────────────────────────────────────────────────
# ENTITY CONFIGURATION
# ───────────────────────────────────────────────────────────────────────────────
entity:
  mob-type: ZOMBIE
  display-name: '&cMy Custom Mob &4❤&c%health%'
  health: 100
  auto-hit:
    enabled: true
    interval: 10

# ───────────────────────────────────────────────────────────────────────────────
# VISUAL SETTINGS
# ───────────────────────────────────────────────────────────────────────────────
visual-settings:
  glow:
    enabled: true
    color: 'RED'
  boss-bar:
    enabled: true
    display: '&cMy Custom Mob &4❤&c%health%'
    color: 'RED'
    overlay: 'PROGRESS'
  damage-indicator:
    enabled: true
    display: '&c-%damage% &4❤'

# ───────────────────────────────────────────────────────────────────────────────
# REWARDS
# ───────────────────────────────────────────────────────────────────────────────
mob-rewards:
  1:
    reward-type: currency
    reward-currency: money
    reward-amount: 100

# ───────────────────────────────────────────────────────────────────────────────
# ENTITY METADATA (Optional)
# ───────────────────────────────────────────────────────────────────────────────
entity-metadata:
  baby: false
  equipment:
    helmet: DIAMOND_HELMET
    main-hand: DIAMOND_SWORD

---

Key Concepts

Mob ID

The filename (without .yml) becomes the mob's ID:

• chicken-common.yml → Mob ID: chicken-common

• skeleton-boss.yml → Mob ID: skeleton-boss

• custom-dragon.yml → Mob ID: custom-dragon

This ID is used when spawning mobs in zones.

Placeholders

Mob configurations support placeholders:

Placeholder	Description	Example
%health%	Current mob health	150
%max_health%	Maximum mob health	200
%damage%	Damage dealt to mob	25
{player}	Player's name	Notch
{amount}	Reward amount	100

You can also use PlaceholderAPI placeholders in mob configurations.

---

Supported Entity Types

Any Minecraft entity type is supported!

Full List of Entity Types