Getting started

Installation

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

Getting the plugin

ExyliaSpawners is a premium plugin, bought on BuiltByBit. It ships through the Lukittu loader, so the file you install is the loader jar, Exylia-Spawners-Loader.jar. Bought on BuiltByBit, the licence is embedded in that jar: there is no key to enter. The loader checks the licence on every start and then hands over to the plugin.

Before you start

Requirement	What for
Paper or Folia 1.21.4+	The server. Folia is supported: every spawner works on its own region thread.
Java 21	The runtime.
`ExyliaLib`	Required, version 1.438.0 or newer: items, menus, the database, prices, the economy, holograms, build zones and the audit log.
`packetevents`	Required by ExyliaLib. ExyliaSpawners uses it for the holograms and for anti-ESP.

ExyliaLib is installed for you

The loader's paper-plugin.yml does not require ExyliaLib on purpose: the loader is what installs it, so it 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.

Optional plugins

Each one lights up when it is installed; none is needed to start.

Plugin	What it adds
`ExyliaMarket`	The prices storage sells at (its worth list and shop), and its sell wands selling a spawner's storage. See Storage and selling.
`ExyliaEconomy` or `Vault`	The currencies sales pay in and upgrades and cleansing cost, through ExyliaLib's economy.
`ExyliaMobs`	Spawner types that spawn ExyliaMobs templates. See Types and tiers.
`ExyliaProtections`, WorldGuard, Lands, GriefPrevention, Towny, SuperiorSkyblock2	Asked before a spawner is placed, mined, stacked or opened. See Trust and protection.
`floodgate`	Bedrock players get a single collect-everything button in the storage screen.
`ExyliaSurvivalCore`	Keeps running; its spawner stacking and item spawners switch off. See Integrations.

Installing

Drop in the jar

Exylia-Spawners-Loader.jar into plugins/, next to packetevents.

Start the server

The loader checks the licence embedded in the jar and hands over to the plugin. The loader installs ExyliaLib if it is missing; if it had to, restart once more.

Let it generate

The plugin writes config.yml, types.yml with every mob your server version knows, tiers.yml, boosters.yml and the lang/ folder with the messages, items, hologram and menus.

Try it

Run /spawnersadmin give <you> zombie and place the item. See First steps.

While the spawners load from the database, a second or so after the start, every spawner action is refused: nothing can be placed, mined, opened or blown up before the plugin knows what is there.

Generated files

All of them live in plugins/ExyliaSpawners/.

File	Contents
`loader.yml`	Written by the loader: `license_key`, and `version` (`auto` keeps the plugin on the newest release).
`config.yml`	Production, placement, mining, explosions, corruption, protection, network, selling, anti-ESP and dashboard settings. See Configuration.
`types.yml`	Every spawner type. See Types and tiers.
`tiers.yml`	Tiers, their track values and upgrade costs. See Types and tiers.
`boosters.yml`	The booster items `/spawnersadmin booster give` hands out. See Upgrades and boosters.
`lang/<language>/messages.yml`	Every chat line, label and prompt.
`lang/<language>/type-names.yml`	What each type is called on screen.
`lang/<language>/spawner-item.yml`	How the spawner item looks.
`lang/<language>/booster-item.yml`	How each booster item looks.
`lang/<language>/hologram.yml`	The hologram over every spawner. See Holograms and anti-ESP.
`lang/<language>/menus/`	The player screens; `menus/admin/` holds the staff screens.
`snapshots/`	Scheduled copies of the plugin's database. See Administration.

English (en) and Spanish (es) ship. Spawners, storage, trusted players, boosters and corruption timers live in the database ExyliaLib provides (database.yml, an H2 file unless you point it elsewhere).

Updating

Replace the loader jar and restart, or leave version: auto in loader.yml. Your configuration, types, tiers and messages are kept and new keys are added with their defaults. The player screens under lang/<language>/menus/ are yours: an update only adds what is missing. The staff screens under menus/admin/ are written again from the jar on every start.

Something missing on this page? Tell us on Discord