Modules

Spawn, state and protection

The six modules that decide where players appear, what they are inside the lobby, and what they may do: spawn, state, protection, join, chat and onboarding.

Each section lists the module's settings from modules/<id>/config.yml, with defaults. Spawn points, effects and similar lists are edited in game from the module's card.

Spawn (`spawn`)

Key	Default	What it does
`command`	`[spawn]`	Labels of the player command. Empty removes it.
`on-join`	`ALWAYS`	Who is sent to spawn when joining inside the lobby: `ALWAYS`, `FIRST_JOIN` or `NEVER`.
`warmup`	`0.0`	Seconds standing still before `/spawn` teleports. 0 is at once. A boss bar counts it down.
`warmup-sounds`	tick, finish, cancel	Sounds of that countdown, heard by that player only, as `NAME\|volume\|pitch`.
`respawn`	`true`	Players who die in the lobby respawn at spawn instead of their bed.
`void-return`	`true`	Send players back to spawn when they fall below `void-y`.
`void-y`	`-70`	The height under which a player in the lobby is sent back. Keep it under the lowest floor.
`points`	none	Spawn points, set in game. The key is the world: a player gets the point of the world they are in, and the first one when their world has none.

Players are moved through ExyliaLib's teleport module, so a move never collides with another one.

Player state (`state`)

Everything below is given back when the player leaves the lobby, and kept on the player so a crash does not lose it.

Key	Default	What it does
`change-game-mode`	`true`	Set the game mode of players entering.
`game-mode`	`ADVENTURE`	`SURVIVAL`, `ADVENTURE`, `CREATIVE` or `SPECTATOR`.
`override-staff-modes`	`false`	Also change players in creative or spectator. Off leaves them alone.
`full-health`	`true`	Heal on entering.
`full-hunger`	`true`	Fill the hunger bar and never let it drop.
`clear-effects`	`false`	Remove every potion effect on entering; they come back on leaving.
`effects`	none	Effects held in the lobby, never running out: `{effect: speed, level: 2, particles: false}`.
`fly`	`true`	Let players with `fly-permission` fly.
`fly-permission`	`exylialobby.fly`	The permission that allows flying.
`time`	`6000`	Fixed time of day shown in the lobby, in ticks. -1 keeps the world's.
`weather`	`CLEAR`	`OFF` keeps the world's, `CLEAR` or `DOWNFALL`.
`xp-bar`	`false`	Show a number on the experience bar. Their own experience is given back.
`xp-level`	`0`	What the level shows: a number or a placeholder such as `%player_ping%`.
`xp-progress`	`0.0`	How full the bar is, 0 to 1.

Protection (`protection`)

Every rule is a switch, all true by default, and applies to everyone inside the lobby except an admin with build mode on (/lobbyadmin build).

Key	Cancels
`block-break`, `block-place`	Breaking blocks, buckets that pick up fluids and harvesting; placing blocks, buckets, paintings, frames, flint and steel and bone meal.
`containers`, `doors`, `buttons-and-levers`, `pressure-plates`	Opening chests, furnaces, anvils, beds and the like; doors, trapdoors and gates; buttons and levers; pressure plates and tripwires.
`frames`, `armor-stands`, `crop-trample`	Item frames and paintings; armor stands; trampling farmland.
`drop-items`, `pickup-items`	Dropping and picking up items. A player who dies keeps their inventory.
`protect-entities`	Players hitting armor stands, animals and every other non-player entity.
`hunger`	The hunger bar dropping.
`cancelled-damage`	Damage of the listed causes (Bukkit `DamageCause` names). PvP is let through only when the PvP module allows it.
`mob-spawning`, `explosions`, `fire-spread`	Natural monster and animal spawns (spawn eggs and plugins still work); explosions; fire spreading and lava or lightning fire.
`leaf-decay`, `ice-and-snow-form`, `ice-and-snow-melt`, `entity-change-block`	Leaves decaying; snow and ice forming and melting; endermen, sheep and falling blocks changing blocks.
`hide-advancement-messages`, `hide-death-messages`	The advancement and vanilla death lines of players in the lobby.

Join and leave (`join`)

Key	Default	What it does
`only-in-lobby`	`true`	Handle only players who join or quit inside the lobby.
`hide-vanilla-messages`	`true`	Hide the vanilla line when no message applies.
`silent-permission`	`exylialobby.join.silent`	Holders, and vanished staff, join and leave without message or commands.
`welcome-delay`	`800ms`	How long after joining the welcome title, sound and MOTD appear.
`groups`	one VIP example	Messages by permission: `permission`, `priority`, `join`, `leave`. The highest priority whose permission the player has wins; an empty permission matches everyone; empty text means no message.
`commands.on-join`, `on-first-join`, `on-quit`	none	Commands run for the player: `console: say hi`, `player: spawn`, `[SERVER] lobby` or `[ACTION] ...`. `%player_name%` works.

Players matching no group get the default lines in the module's messages.yml.

Chat (`chat`, off by default)

Chat control only. Keep your chat plugin for formatting.

Key	Default	What it does
`bypass-permission`	`exylialobby.chat.bypass`	Ignores the lock and slow mode and keeps chat when cleared.
`locked-at-start`	`false`	Start with chat locked.
`slow-mode-seconds`	`0`	Seconds between two messages of one player. 0 is off.
`clear-lines`	`100`	Blank lines `/lobbyadmin chat clear` sends.

Live: /lobbyadmin chat lock, /lobbyadmin chat slow <seconds>, /lobbyadmin chat clear. A restart goes back to the file.

Onboarding (`onboarding`, off by default)

Key	Default	What it does
`journey`	`welcome`	The id of the ExyliaJourney journey that welcomes new players. Leave that journey's own `FIRST_JOIN` trigger off or players start it twice.
`first-join-only`	`true`	Only players joining for the first time. The journey's own rules still apply.
`delay`	`3s`	How long after joining the journey starts.
`fallback-commands`	none	Commands run instead when ExyliaJourney is not installed. Empty does nothing without it.

Something missing on this page? Tell us on Discord

Spawn (spawn)

Player state (state)

Protection (protection)

Join and leave (join)