Reference

Configuration

Every key of config.yml with its default, plus the messages, items and menus files.

plugins/ExyliaSpawners/config.yml holds everything that is not a type, a tier, a booster, a message or a menu. Times are written 30s, 5m or 1h30m. Apply a hand edit with /spawnersadmin reload; only network.enabled needs a restart. Types and tiers are on their own page, boosters under Upgrades and boosters.

General

languagestringpor defecto default

default follows the language set in ExyliaLib's config.yml; en or es sets this plugin alone. Each is a folder under lang/ you can edit.

debugbooleanpor defecto false

Explains in the console what the plugin is doing, including every production cycle.

default-modestringpor defecto VIRTUAL

How spawners produce unless their type or tier says otherwise: VIRTUAL (loot and experience into storage, no mobs) or CLASSIC (real mobs next to the spawner).

Production: `production`

Key	Default	What it does
`production.interval-ticks`	`20`	Ticks between production checks. Each spawner still waits its own delay.
`production.activation-range`	`16`	Blocks: a spawner only produces, and only builds corruption, while a player is this close.
`production.spawn-radius`	`4`	CLASSIC only: blocks around the spawner where mobs appear.
`production.nearby-limit`	`12`	CLASSIC only: no more mobs appear while this many of its type are within 8 blocks.

Storage and collecting

Key	Default	What it does
`storage.flush-interval`	`30s`	How often produced loot is written to the database. Chunk unloads and shutdowns write too.
`collecting.mending-repair`	`true`	Claimed experience repairs Mending items first.
`collecting.full-to-collect`	`false`	Items can only be taken out once the storage is full. Selling is not affected.

Placing: `placement`

Key	Default	What it does
`placement.chunk-limit`	`0`	Most spawner blocks in one chunk; `0` is no limit.
`placement.player-limit`	`0`	Most spawner blocks one player may have placed, unless they hold `exyliaspawners.limit.<n>`; `0` is no limit. Counts every server in network mode.
`placement.require-type-permission`	`false`	Ask for `exyliaspawners.place.<type>` to place a type.

Mining: `mining`

Key	Default	What it does
`mining.tools`	`['*_PICKAXE']`	Tools that can mine a spawner: material names, `*` as a wildcard.
`mining.require-silk-touch`	`true`	The tool must carry Silk Touch.
`mining.chance`	`100.0`	Percent chance that mining drops the spawner; a failed roll destroys it. `exyliaspawners.chance.<n>` can raise it.
`mining.require-type-permission`	`false`	Ask for `exyliaspawners.mine.<type>` to mine a type.
`mining.require-empty-storage`	`true`	The last spawner of a stack cannot be mined while its storage holds items or experience. Off, whatever it held is lost with it.
`mining.to-inventory`	`true`	Mined spawners go straight into the miner's inventory (what does not fit drops at their feet) instead of on the ground, where somebody else could pick them up.

Explosions, eggs and conversion

Key	Default	What it does
`explosions.enabled`	`true`	Explosions take one spawner off a stack. A spawner holding items is never blown up.
`explosions.drop-chance`	`50.0`	Percent chance the blown spawner drops as an item.
`egg-change.enabled`	`false`	Right-clicking a spawner with a spawn egg changes its type, one egg per spawner in the stack.
`conversion.enabled`	`true`	Vanilla spawners become ExyliaSpawners the first time a player clicks or mines them. Trial spawners are never touched.
`conversion.tier`	`1`	Tier a converted spawner gets; also the tier of imported spawners that kept none.

Snapshots: `snapshots`

Key	Default	What it does
`snapshots.enabled`	`true`	A full copy of the plugin's database in `snapshots/`, on a timer.
`snapshots.interval`	`6h`	How often.
`snapshots.keep`	`8`	Newest snapshots kept.

Corruption: `corruption`

Key	Default	What it does
`corruption.enabled`	`true`	Spawners slowly corrupt while players are near them and must be cleansed on site.
`corruption.disabled-worlds`	`[]`	Worlds where spawners never corrupt; a corrupted one there produces as if healthy.
`corruption.defaults`	`HALT`, `6h`–`12h`	The rule of every tier not listed under `tiers`.
`corruption.tiers.<tier>.effect`	1 `HALT`, 2 `REDUCED`, 3 `TAINTED`	`HALT`, `REDUCED`, `TAINTED` or `NONE`.
`corruption.tiers.<tier>.min`, `max`	1 `6h`/`12h`, 2 `4h`/`8h`, 3 `3h`/`6h`	The random timer, counted only while a player is in activation range.
`corruption.tiers.<tier>.multiplier`	`0.5` (tier 3: `1.5`)	`REDUCED`: speed multiplier. `TAINTED`: loot multiplier.
`corruption.tiers.<tier>.loss-chance`	`0` (tier 3: `10`)	`TAINTED`: percent chance per full timer spent corrupted to lose one spawner, never the last.
`corruption.grace`	`30m`	After a cleanse the spawner cannot corrupt for this long.
`corruption.repair.range`	`4.0`	Blocks: how close the owner or a trusted player must stand.
`corruption.repair.duration`	`3s`	How long they hold crouch.
`corruption.repair.currency`	`''`	Currency charged per cleanse; blank is the server default.
`corruption.repair.cost`	`0.0`	Money per cleanse; `0` is free.
`corruption.repair.cleanser-item`	`''`	A material taken from the inventory per cleanse; blank for none.
`corruption.repair.cleanser-amount`	`1`	How many of it.
`corruption.repair.on-complete`	a chime sound	Interaction lines played when the cleanse finishes.
`corruption.cap.money-per-hour`	`0.0`	Anti-inflation: a spawner earning more than this corrupts faster, in proportion. `0` is off.
`corruption.cap.max-speed`	`4.0`	At most this many times faster.
`corruption.particles.particle`	`WITCH\|3\|0.35\|0.35\|0.35\|0`	Shown around a corrupted spawner while a player is near: `NAME\|count\|dx\|dy\|dz\|speed`, blank for none.
`corruption.particles.radius`	`12.0`	Blocks: who sees them.
`corruption.particles.every`	`2s`	How often.

See Corruption.

Protection: `protection`

Key	Default	What it does
`protection.enabled`	`true`	Ask the region and claim plugins before a spawner is placed, mined, stacked or opened.
`protection.sources`	all seven	`WORLDGUARD`, `EXYLIA_REGIONS`, `EXYLIA_PROTECTIONS`, `LANDS`, `GRIEF_PREVENTION`, `TOWNY`, `SUPERIOR_SKYBLOCK`. One that is not installed always allows.

Network, selling and anti-ESP

Key	Default	What it does
`network.enabled`	`false`	List and sell a player's spawners from every server. Needs a shared database and Redis. Restart to apply. See Network.
`selling.autosell-interval`	`60s`	How often a spawner with autosell on sells its storage, while its owner is online and holds `exyliaspawners.autosell`.
`anti-esp.enabled`	`true`	Far players are sent a plain block instead of the spawner. Needs PacketEvents.
`anti-esp.distance`	`24.0`	Blocks: closer than this a player sees the real spawner. Never below 8.
`anti-esp.disguise`	`AUTO`	`AUTO` (the most common solid block around it, else `STONE`) or a block name.
`anti-esp.worlds`	`['*']`	Worlds where it applies; `*` is a wildcard.

Dashboard alerts: `dashboard`

Key	Default	What it does
`dashboard.webhook`	`''`	Discord webhook the alerts go to. Empty turns them off.
`dashboard.owner-money-per-hour`	`0`	Alert when one owner's spawners sold more than this in the last hour (default currency). `0` is off.
`dashboard.server-money-per-hour`	`0`	Alert when every spawner on this server sold more than this in the last hour. `0` is off.
`dashboard.check-every`	`1m`	How often the rates are checked.
`dashboard.cooldown`	`30m`	At most one alert per owner, and one for the server, in this time.
`dashboard.owner-alert`	`SPAWNER SELL RATE`	The owner alert. Placeholders: `%owner%`, `%owner_head%`, `%money%`, `%threshold%`, `%spawners%`.
`dashboard.server-alert`	`SERVER SPAWNER SELL RATE`	The server alert. Placeholders: `%money%`, `%threshold%`, `%spawners%`.

See Administration.

Messages, items and menus

File	What it holds
`lang/<language>/messages.yml`	Every chat line, label and prompt, by feature. Colours use palette tokens such as `{primary}` or `{error}`. A line may open with `[sound:NAME\|volume\|pitch]` or `[center]`, which never reach the screen; `%prefix%` is the `prefix` value; an empty message is not sent.
`lang/<language>/type-names.yml`	Display names of types.
`lang/<language>/spawner-item.yml`, `booster-item.yml`	The items, as ExyliaLib items.
`lang/<language>/hologram.yml`	The hologram. See Holograms and anti-ESP.
`lang/<language>/menus/*.yml`	The player screens: `hub`, `storage`, `upgrades`, `boosters`, `trust`, `corruption`, `my_spawners`. Yours to restyle: an update only adds what is missing.
`lang/<language>/menus/admin/`	The staff screens, written again from the jar on every start.

The values each screen can show are listed under Placeholders.

Something missing on this page? Tell us on Discord

General

Production: production

Storage and collecting

Placing: placement

Mining: mining