Mobs API

Mob configuration templates and utility mobs for game mechanics.

Base Mob Templates

hostile_mob

Base template for hostile mobs.

hostile_mob:
  Type: SKELETON
  Faction: Hostile
  Display: 'Base Hostile Mob'
  Health: 20
  Damage: 4
  Options:
    Despawn: true
    Silent: true
    DigOutOfGround: true
    AlwaysShowName: false
    PreventRandomEquipment: false
    PreventItemPickup: true
    PreventOtherDrops: true
    PreventJockeyMounts: true
    PreventTransformation: true
    PreventSunburn: true
    FollowRange: 32
    MovementSpeed: 0.2
    AttackSpeed: 4

Attributes:

Type

string

required

Minecraft entity type

Faction

string

Mob faction: Hostile, Friendly, Passive

Display

string

Display name (supports color codes)

Health

number

default:"20"

Maximum health

Damage

number

default:"1"

Base damage

Options

Options.Despawn

boolean

default:"true"

Allow natural despawning

Options.Silent

boolean

default:"false"

Suppress sounds

Options.AlwaysShowName

boolean

default:"false"

Always display nameplate

Options.FollowRange

number

default:"32"

Entity detection range

Options.MovementSpeed

number

default:"0.2"

Movement speed multiplier

Options.AttackSpeed

number

default:"4"

Attacks per second

Options.PreventRandomEquipment

boolean

default:"false"

Prevent random armor/weapons

Options.PreventItemPickup

boolean

default:"false"

Prevent picking up items

Options.PreventOtherDrops

boolean

default:"false"

Prevent vanilla drops

Options.PreventJockeyMounts

boolean

default:"false"

Prevent jockey mounting

Options.PreventTransformation

boolean

default:"false"

Prevent zombie/piglin transformation

Options.PreventSunburn

boolean

default:"false"

Prevent sun damage

Options.DigOutOfGround

boolean

default:"false"

Can dig out when spawned underground

hostile_mob-advanced

Advanced hostile mob with AI templates.

hostile_mob-advanced:
  Type: Husk
  Display: 'Advanced Hostile Mob'
  Template: hostile_mob,detection_ai,mob_levelling
  Health: 20
  Options:
    FollowRange: 64
    MovementSpeed: 0.3
    AttackSpeed: 4
  Variables:
    debug: false
    equipment_power: 12
    equipment: equipment-vanilla_melee

Inherits:

hostile_mob: Base stats
detection_ai: Detection and aggro AI
mob_levelling: Level scaling system

Mob Templates

detection_ai

Advanced detection and aggro system (from detection_ai-template.yml). Features:

Line-of-sight detection
Aggro range management
Alert state system
Patrol behavior

mob_levelling

Level-based stat scaling (from mob_levelling-template.yml). Features:

Health scaling by level
Damage scaling by level
Equipment quality scaling
Experience rewards

mob_spawner

Spawner controller template (from mob_spawner-template.yml). Features:

Wave spawning
Spawn limits
Weighted spawn tables
Cooldown management

Game Mechanic Mobs

channel_indicator

Visual indicator for spell channeling.

channel_indicator:
  Type: text_display
  Display: ''
  Faction: SERVER
  DisplayOptions:
    Text: ""
    LineWidth: 100
    Billboard: CENTER
    Scale: 1,1,1
    Translation: 0,0.5,0
    BlockLight: 15
    SkyLight: 15
  Options:
    Marker: true
    Invisible: true
    HasGravity: false
  Variables:
    spell_name: ''
    channel_duration: ''
  Skills:
  - remove @self ~onTimer:10 ?!hasParent
  - remove @self ~onDismounted

Usage: Automatically summoned by spell_handler during channeling. Display Options:

DisplayOptions.Text

string

Text content (updated by spell system)

DisplayOptions.Billboard

string

default:"CENTER"

Billboard mode: CENTER, FIXED, VERTICAL, HORIZONTAL

DisplayOptions.Scale

vector

default:"1,1,1"

X, Y, Z scale

DisplayOptions.Translation

vector

default:"0,0.5,0"

X, Y, Z offset

DisplayOptions.BlockLight

integer

default:"15"

Block light level (0-15)

DisplayOptions.SkyLight

integer

default:"15"

Sky light level (0-15)

damage_indicator

Floating damage number display (from damage_indicator-mob.yml). Features:

Text display entity
Animated movement toward caster
Color-coded by damage type
Auto-removal after duration

generic_marker-mobs

Generic marker entities for various purposes (from generic_marker-mobs.yml). Types:

Location markers
Waypoint markers
Area markers

targeting_marker-mobs

Target reticle and selection markers (from targeting_marker-mobs.yml). target_marker-block Reticle for target selection system.

target_marker-block:
  Type: block_display
  Faction: SERVER
  Options:
    Marker: true
    Invisible: false
    HasGravity: false
  Skills:
  - remove @self ~onTimer:100 ?!hasParent

Features:

Block display entity for reticle
Follows selected target
Auto-removes when orphaned

summon-mobs

Player summon templates (from summon-mobs.yml). Features:

Owner tracking
Parent relationship
Combat state management
Custom nameplate

timer-display-mobs

Timer and countdown displays (from timer-display-mobs.yml). Features:

Text display entity
Countdown/countup modes
Custom formatting

Mob Configuration Format

Core Fields

Type

string

required

Minecraft entity type (e.g., ZOMBIE, SKELETON, text_display)

Template

string

Inherit from template(s), comma-separated

Faction

string

default:"Hostile"

Faction: Hostile, Friendly, Passive, SERVER

Display

string

Display name (supports color codes and placeholders)

Health

number

default:"20"

Maximum health

Damage

number

default:"1"

Base attack damage

Armor

number

default:"0"

Armor points

KnockbackResistance

number

default:"0"

Knockback resistance (0.0-1.0)

Variables

Variables:
  debug: false
  equipment_power: 12
  equipment: equipment-vanilla_melee
  model_id: "custom_model"

Custom variables accessible via <caster.var.variable_name>.

Variables.save

boolean

default:"false"

Persist variables through server restarts

Equipment

Equipment:
- DIAMOND_SWORD HAND
- DIAMOND_HELMET HEAD
- DIAMOND_CHESTPLATE CHEST
- DIAMOND_LEGGINGS LEGS
- DIAMOND_BOOTS FEET
- SHIELD OFFHAND

Slots:

HAND: Main hand
OFFHAND: Off hand
HEAD: Helmet
CHEST: Chestplate
LEGS: Leggings
FEET: Boots

Skills

Skills:
- skill{s=mob-init} ~onSpawn
- skill{s=mob-tick} ~onTimer:20
- skill{s=mob-death} ~onDeath
- skill{s=mob-damaged} ~onDamaged
- skill{s=mob-attack} ~onAttack

Common Triggers:

~onSpawn: When mob spawns
~onLoad: When chunk loads
~onDeath: When mob dies
~onTimer:X: Every X ticks
~onDamaged: When taking damage
~onAttack: When attacking
~onTarget: When acquiring target
~onCombat: When entering combat
~onDropCombat: When leaving combat

Display Entities

For text_display, block_display, and item_display entities.

DisplayOptions

DisplayOptions:
  Text: "Display Text"
  LineWidth: 200
  Billboard: CENTER
  BackgroundColor: 0,0,0,64
  TextOpacity: 255
  Scale: 1,1,1
  Translation: 0,0,0
  BlockLight: 15
  SkyLight: 15

DisplayOptions.Text

string

Text content (text_display only)

DisplayOptions.LineWidth

integer

default:"200"

Maximum line width before wrapping

DisplayOptions.Billboard

string

default:"FIXED"

Billboard mode: CENTER, FIXED, VERTICAL, HORIZONTAL

DisplayOptions.BackgroundColor

string

default:"0,0,0,64"

RGBA background color

DisplayOptions.TextOpacity

integer

default:"255"

Text opacity (0-255)

Summon Handler Integration

summon-init

Automatically called on summon spawn. Sets:

caster.owneruuid: Owner’s UUID
caster.ownername: Owner’s name
caster.combatstate: Combat state (1=Idle, 2=Low Alert, 3=High Alert, 4=Combat)
Parent and owner relationships
Custom nameplate

summon-tick

Automatic behavior updates.

Look at target in combat
Track target location
Update stance based on combat state

summon-death

Notifies owner of summon death.

summon-death:
  Skills:
  - message{m="<dark_grey>[<red>!<dark_grey>] <grey>Your <white><caster.name> <grey>has fallen."} @UUID{u=<caster.var.owneruuid>}

Skills

Items & Mobs

Base Mob Templates

hostile_mob

Options

hostile_mob-advanced

Mob Templates

detection_ai

mob_levelling

mob_spawner

Game Mechanic Mobs

channel_indicator

damage_indicator

generic_marker-mobs

targeting_marker-mobs

summon-mobs

timer-display-mobs

Mob Configuration Format

Core Fields

Variables

Equipment

Skills

Display Entities

DisplayOptions

Summon Handler Integration

summon-init

summon-tick

summon-death

Build docs developers (and LLMs) love

Skills

Items & Mobs

​Base Mob Templates

​hostile_mob

​Options

​hostile_mob-advanced

​Mob Templates

​detection_ai

​mob_levelling

​mob_spawner

​Game Mechanic Mobs

​channel_indicator

​damage_indicator

​generic_marker-mobs

​targeting_marker-mobs

​summon-mobs

​timer-display-mobs

​Mob Configuration Format

​Core Fields

​Variables

​Equipment

​Skills

​Display Entities

​DisplayOptions

​Summon Handler Integration

​summon-init

​summon-tick

​summon-death

Build docs developers (and LLMs) love

Base Mob Templates

hostile_mob

Options

hostile_mob-advanced

Mob Templates

detection_ai

mob_levelling

mob_spawner

Game Mechanic Mobs

channel_indicator

damage_indicator

generic_marker-mobs

targeting_marker-mobs

summon-mobs

timer-display-mobs

Mob Configuration Format

Core Fields

Variables

Equipment

Skills

Display Entities

DisplayOptions

Summon Handler Integration

summon-init

summon-tick

summon-death