# Lode Entities

> Documentation for LodeEntities: custom mobs, Blockbench models, MythicMobs-style effects, spawners, NPCs and pets for Paper and Folia.

- [Welcome to LodeEntities](https://entities.lodemc.net/index.md): Custom mobs, models and boss mechanics in a single plugin.
- [My First Mob](https://entities.lodemc.net/my-first-mob.md): Install LodeEntities, then create and spawn your first custom mob in five minutes.
- [My First Effect](https://entities.lodemc.net/my-first-effect.md): Give your mob personality: greetings, reactions and a dramatic death.
- [Mob Stats](https://entities.lodemc.net/mob-fields.md): Every setting a mob can carry, what it defaults to, and the range it accepts.
- [Equipment](https://entities.lodemc.net/mob-equipment.md): Dress a mob: what it wears and holds, per slot, from vanilla or custom-item plugins, in YAML or in game.
- [Aging & Growth](https://entities.lodemc.net/mob-aging.md): Let a mob grow into another one after a while, in real time.
- [Levels](https://entities.lodemc.net/mob-levels.md): Where a mob's level comes from, and what reads it.
- [Spawners](https://entities.lodemc.net/spawners.md): A spot in a world that keeps a population of one mob alive around itself.
- [Natural Spawns](https://entities.lodemc.net/natural-spawns.md): Mobs that appear wherever the world suits them, with no spawner placed anywhere.
- [Player Disguise](https://entities.lodemc.net/player-disguise.md)
- [Player Undisguise](https://entities.lodemc.net/player-undisguise.md)
- [Play Player Animation](https://entities.lodemc.net/player-play-animation.md)
- [Entities Menu](https://entities.lodemc.net/gui.md): The Entities menu: a spawn egg for every registered mob, browsable and paginated.
- [Removing Spawned Mobs](https://entities.lodemc.net/killall.md): Bulk-remove the mobs LodeEntities spawned: all of them, or the ones a filter names.
- [Spawning Where You Look](https://entities.lodemc.net/spawnlook.md)
- [Spawning at Coordinates](https://entities.lodemc.net/spawnat.md)
- [Spawning an Entity](https://entities.lodemc.net/spawn.md)
- [Test Model](https://entities.lodemc.net/test-model.md)
- [Hide Entity](https://entities.lodemc.net/hide-mob.md)
- [Show Entity](https://entities.lodemc.net/show-entity.md)
- [Reloading LodeEntities](https://entities.lodemc.net/reload.md)
- [Version and Edition](https://entities.lodemc.net/version-check.md)
- [Reconvert MythicMobs Files](https://entities.lodemc.net/reconvert.md)
- [Debug Report](https://entities.lodemc.net/debug.md): The config report: every load problem with the part that's wrong and how to fix it.
- [Spawner Commands](https://entities.lodemc.net/spawner-commands.md): The full /le spawner reference: list, info, create, remove, enable, disable, reset, trigger, tp.
- [Spawn Rule Commands](https://entities.lodemc.net/spawnrule-commands.md): The full /le spawnrule reference: list, info, test, trigger, enable, disable, reset.
- [Run an Effect](https://entities.lodemc.net/effect-start.md): Run a skill manually with yourself as the caster.
- [How Effects Work](https://entities.lodemc.net/overview.md): The effect line: what happens, when, and to whom. Written the same way as MythicMobs skills.
- [Triggers](https://entities.lodemc.net/triggers.md): When an effect line runs: every trigger, what fires it, and who @trigger is.
- [Targeters](https://entities.lodemc.net/targeters.md): Who or where an effect line acts on: every targeter, and the options they share.
- [Conditions](https://entities.lodemc.net/conditions.md): Yes/no tests that gate skills, lines, targets and spawns: the language and every condition.
- [Line Options](https://entities.lodemc.net/line-options.md): Options every mechanic takes (delay, repeat, cooldown, chance, power, origin) and the inline parts of a line.
- [Placeholders](https://entities.lodemc.net/placeholders.md): Tokens like <caster.hp> and <target.name> that are filled in when a line runs, in text and in numbers.
- [All Mechanics](https://entities.lodemc.net/mechanics.md): Every mechanic, grouped by what it does, and the rules they all share.
- [Skills & Flow](https://entities.lodemc.net/mechanics-flow.md): Calling skills, pausing, branching, looping, timers, signals and variables.
- [Messaging & UI](https://entities.lodemc.net/mechanics-messaging.md): Chat, action bars, titles, toasts, boss bars, sounds and commands.
- [Combat & Health](https://entities.lodemc.net/mechanics-health.md): Damage, healing, shields, potions, attributes and threat.
- [Movement & Mounts](https://entities.lodemc.net/mechanics-movement.md): Teleports, knockback, leaps and lunges, facing, pathfinding and mounts.
- [World & Blocks](https://entities.lodemc.net/mechanics-world.md): Summoning, explosions and lightning, blocks, visual effects, screen effects, scoreboards and spawners.
- [Entity State](https://entities.lodemc.net/mechanics-entity-state.md): Names, AI, gravity, glow, fire, owners and stances, tags, experience, time and weather, and entity-specific tricks.
- [Items](https://entities.lodemc.net/mechanics-items.md): Giving, dropping, taking, stealing and equipping items, and currency.
- [Particles](https://entities.lodemc.net/mechanics-particles.md): Particle bursts and shapes: rings, spheres, lines, helices, orbitals, tornados, slashes and equations.
- [Projectiles](https://entities.lodemc.net/mechanics-projectiles.md): Custom projectiles, missiles, orbitals, totems, beams, chains, vanilla shots and ray traces.
- [Auras](https://entities.lodemc.net/mechanics-auras.md): Timed effects on an entity: buffs and debuffs, event auras, stuns, glows, cast bars and speech.
- [Model Animation](https://entities.lodemc.net/mechanics-animation.md): Play and stop a model's animations, lock its rotation, and add or remove models at runtime.
- [Flow Control](https://entities.lodemc.net/flow-control.md): delay, skill, if, loop, while, switch and random skills: sequences and decisions.
- [Variables](https://entities.lodemc.net/variables.md): Let mobs remember things: writing, reading, scopes and placeholders.
- [Timers & Auras](https://entities.lodemc.net/timers-auras.md): Run effects on a timer with repeat, pulse and stoprepeat, or with +onTimer.
- [Particle Equations](https://entities.lodemc.net/particle-equations.md): Plot animated particle shapes from math formulas.
- [Skills](https://entities.lodemc.net/named-effects.md): Reusable lists of effect lines: inside a mob or anywhere in Mobs/, with gates, cooldowns and parameters.
- [Building a Boss](https://entities.lodemc.net/building-a-boss.md): A complete two-phase boss, built step by step from everything in the Effects section.
- [Factions & Threat](https://entities.lodemc.net/factions-threat.md): Give mobs sides and a threat table: factions.yml, threat config, and the taunt mechanics.
- [What are Models](https://entities.lodemc.net/models.md): What models are and how the pipeline works, from Blockbench to your server.
- [Creating a Model](https://entities.lodemc.net/creating-a-model.md): From an empty Blockbench window to a server-ready .bbmodel: project setup, cubes, bones and textures.
- [Importing Your Model](https://entities.lodemc.net/importing-a-model.md): Get your .bbmodel from Blockbench into the world: folder, reload, resource pack, spawn.
- [Animating Your Model](https://entities.lodemc.net/animating-a-model.md): Animations that play themselves, testing them, math-driven motion, and running skills on a keyframe.
- [Bone Tags](https://entities.lodemc.net/bone-tags.md): Special bone name prefixes that add behaviors: head tracking, hitboxes, nametags, shadows and mounts.
- [Custom Hitboxes](https://entities.lodemc.net/custom-hitboxes.md): Draw your mob's hittable area in Blockbench with b_ bones: multiple hitboxes, animation-following, mount points.
- [Custom Nametags](https://entities.lodemc.net/custom-nametags.md): Position the floating name with tag_ bones, and control its visibility with ptag_ and mtag_.
- [Custom Shadows](https://entities.lodemc.net/custom-shadows.md): Size the ground shadow to your creature with a shadow bone.
- [MythicMobs](https://entities.lodemc.net/mythicmobs.md): MythicMobs skill lines load as written, and MythicMobs mob, skill and spawner files convert on load.
- [Nexo & ItemsAdder](https://entities.lodemc.net/resource-pack-compat.md): Merge LodeEntities' generated model assets into Nexo or ItemsAdder so players load one pack, and use their items on mobs.
- [Folia](https://entities.lodemc.net/folia.md): Per-subsystem Folia support: verified, untested, and known limitations.
- [NPCs](https://entities.lodemc.net/npcs.md): An NPC is a mob with type: npc: shopkeepers and quest givers that stand still, look at players and start conversations.
- [NPC Dialogs](https://entities.lodemc.net/dialogs.md): Branching NPC conversations: assigning one, node structure, choices, effects and endings.
- [Dialog Conditions](https://entities.lodemc.net/dialog-conditions.md): Gate nodes and choices: time, weather, items, permissions, and combining with variables.
- [Dialog Files](https://entities.lodemc.net/dialog-files.md): Organize conversations: inline nodes, one file per node, folder conventions and the YAML brace gotcha.
- [Pets](https://entities.lodemc.net/pets.md): Mobs that belong to a player: tamed, claimed or given, they follow, fight, level up, evolve and can be ridden. Premium only.
- [Pet Settings](https://entities.lodemc.net/pet-settings.md): Every field of a mob's pet: block, the pets section of config.yml, commands and permissions.
- [File Layout](https://entities.lodemc.net/file-layout.md): Where everything lives under plugins/LodeEntities, and how the Mobs/ folder is read.
- [Config Reference](https://entities.lodemc.net/config-reference.md): Every option in config.yml, grouped, with its default.
- [Menu Overlay](https://entities.lodemc.net/menu-overlay.md): Paint a custom image over the Entities menu, baked into the generated pack.
- [Free Version & Licensing](https://entities.lodemc.net/licensing.md): What the free version allows, adding a license key, and licensing a whole network through a Velocity proxy.
- [Addon API](https://entities.lodemc.net/addon-api.md): Extend LodeEntities from your own plugin: setup, the entry point, and the API surfaces.
- [Extending the Effect Language](https://entities.lodemc.net/extending-effects.md): Five extension points for the effect DSL: mechanics, targeters, triggers, conditions and placeholders.
- [Models & Animation](https://entities.lodemc.net/addon-models.md): Attach models to any entity, play animations, drive bones and hitboxes from code.
- [Mobs & Factions](https://entities.lodemc.net/addon-mobs.md): Spawn and inspect registered mobs from code, drive factions and threat, and ship bundled mob definitions.
- [Spawners](https://entities.lodemc.net/addon-spawners.md): Read and drive placed spawners from code: lookup, groups, live counts, enable, reset and trigger.
- [Natural Spawns](https://entities.lodemc.net/addon-natural-spawns.md): Natural spawn rules from code, plus how a custom world generator plugs its biomes into them.
- [NPCs & Dialogs](https://entities.lodemc.net/addon-npcs-dialogs.md): Tell NPCs from plain mobs in code, and start branching conversations for any player.
- [Pets](https://entities.lodemc.net/addon-pets.md): Read and drive players' pets from code, and react to taming and summoning.
- [Events](https://entities.lodemc.net/addon-events.md): Bukkit events for addons: mob spawns, NPC interactions and reloads.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.