Content generated with AI — it may contain mistakes.

Getting started

Introduction

What ExyliaMobs is, what a custom mob and a generator are, what it needs to run and how this documentation is organised.

ExyliaMobs builds custom mobs in game. A staff member opens /mobsadmin, creates a mob, and dresses it up from one screen: its name and type, equipment, attributes, flags, potion effects, skills from a library of staged attacks, fight phases, a look, and, if they like, a Blockbench model it wears instead of its vanilla body, with no resource pack. Then they decide what it pays: ten reward lists, from the top damager's to the loot thrown out where it dies.

Generators keep those mobs alive. A generator is an area of the map: while a player is near it, it spawns waves of the mobs it is given, up to a maximum, on the ground inside the area.

It is a premium plugin, installed through a licence loader. See Installation.

The mob engine itself — spawning, skills, casts, phases, reactions and models — is ExyliaLib's, documented on Mobs and models. ExyliaMobs is the part a server owner uses: it stores the templates, gives them editors, places the generators and pays for the kills.

What is included

Requirements

RequirementDetail
ServerPaper 1.21.4 or newer, or a fork of it. Folia supported.
Java21
Required dependenciespacketevents, and ExyliaLib 1.331.0 or newer — installed for you if it is missing
Optional dependenciesExyliaEconomy or Vault, for money rewards; PlaceholderAPI; ExyliaSurvivalCore, for kill counters
About ExyliaLib

The mob and model engine, the skill library, every editor the template screen opens, the reward lists and their delivery, boosters, menus and prompts, the area selector and the database all come from ExyliaLib. ExyliaMobs is written on top of it and does not run without it, which is why the loader installs it on a server that lacks it.

Shared by a network

Mobs are network content: every server pointed at the same database spawns from the same templates. Generators are places: each one belongs to the server it was created on. See Generators.

Other plugins

ExyliaMobs offers its templates to other plugins through ExyliaLib's shared mob store. ExyliaRewards uses it for vote party piñatas: a piñata is an ExyliaMobs mob, and its EDIT MOB button opens this plugin's mob screen, whose BACK returns to the piñata. See API.

Languages

The plugin ships English, Spanish, French, Portuguese, Russian and Turkish (en, es, fr, pt, ru, tr): every message and every screen. It follows the language set in ExyliaLib's config.yml. See Configuration.

Something missing on this page? Tell us on Discord