Getting started

Installation

The loader jar and the licence key, dependencies, the files the plugin writes, the database and updating.

Getting the plugin

ExyliaMobs is a premium plugin. It ships through the Lukittu loader, so the file you install is the loader jar, Exylia-Mobs-Loader.jar. It is not sold on BuiltByBit: request your licence key on the Exylia Discord, and manage your keys and servers at licenses.exylia.net. The loader checks the licence on every start and then hands over to the plugin.

Before you start

Plugin	What for
`packetevents`	Required. Declared under `depend`, so without it the server does not load ExyliaMobs at all. Skill telegraphs, reactions, floating numbers and models are drawn with packets.
`ExyliaLib`	Required, version 1.331.0 or newer. The mob and model engine, editors, rewards, menus, the area selector and the database.

ExyliaLib is listed as soft, and installed for you

The loader's plugin.yml names ExyliaLib under softdepend on purpose: the loader is what installs it, so the loader has to be allowed to start without it. On a server without ExyliaLib it downloads the newest release into plugins/ and asks for a restart. On a server running an older release it stages the newest one and says so in the console; restart once more to apply it.

Optional plugins

Plugin	What it adds
`ExyliaEconomy` or `Vault`	Money rewards in the reward lists. ExyliaMobs loads after them so they are ready when a mob pays.
`PlaceholderAPI`	Loaded before ExyliaMobs when present, for ExyliaLib's text. ExyliaMobs registers no placeholders of its own.
`ExyliaSurvivalCore`	Counts the kills of the top damager as statistics counters. See Rewards.
`ExyliaRewards`	Uses ExyliaMobs' mobs as vote party piñatas.
`WorldGuard`	Not needed, but its spawn flags can block generators. See Generators.

Installing

Drop in the jars

Exylia-Mobs-Loader.jar and packetevents into plugins/.

Start the server

The loader writes loader.yml. Stop the server, put your key in license_key and start it again. The loader installs ExyliaLib if it is missing; if it had to, restart once more.

Let it generate

The plugin writes config.yml, its messages and screens, the three showcase models, and creates its tables. The console ends with ExyliaMobs enabled.

Open the screens

Run /mobsadmin as an operator. Three showcase mobs are already there to spawn: stone_golem, crawler and wisp. See Building a mob.

Generated files

All of them live in plugins/ExyliaMobs/.

File	Contents
`loader.yml`	Written by the loader: `license_key`, and `version` (`auto` keeps the plugin on the newest release).
`config.yml`	What every mob and generator shares: payment rules, the generator cap and timer, auras, visuals and skill colours. See Configuration.
`database.yml`	Where rows are stored. Written by ExyliaLib.
`lang/<language>/messages.yml`	Every chat line, prompt, editor title and the words the screens fill in.
`lang/<language>/menus/admin/`	The seven screens: `admin`, `templates`, `template`, `template_model`, `models`, `generators` and `generator`. Rewritten from the jar on every start.
`models/`	The Blockbench models mobs can wear. Ships `stone_golem`, `crawler` and `wisp`.
`models/.bundled`, `showcase-mobs.txt`	Which showcase models and mobs were already handed over, so one you delete does not come back.

The screens are the plugin's

The menu files are replaced with the jar's on every start, so a change made to them is lost on the next restart. Their header says edits are kept; that is not how this plugin loads them. Change what the screens say through messages.yml instead, which is kept.

The database

Three tables in the database database.yml points at: H2 in a file by default, or MySQL, MariaDB, PostgreSQL or MongoDB through ExyliaLib.

Table	Contents
`sc_mob_templates`	One row per mob. Shared by every server on the database.
`sc_mob_generators`	One row per generator, with the server it belongs to.
`exylia_pending_rewards`	Rewards a player could not take yet, handed over on their next join. Written by ExyliaLib.

Templates and generators are kept in memory and written on every change. Live mobs are not stored: the library removes them on a stop, and generators spawn fresh ones after the start.

Rows written by an earlier version that kept money, currencies or experience outside the reward lists are moved into them the first time they are read: the money becomes economy rewards in the top damager's list, the experience an experience reward in the death loot.

Updating

Replace the loader jar and restart, or leave version: auto in loader.yml. config.yml and the messages are kept, and new keys are added with their defaults. The screens are replaced, as above.

Something missing on this page? Tell us on Discord