Content generated with AI — it may contain mistakes.

The lobby

Lobby areas

Where the lobby is: whole worlds, boxes inside other worlds and WorldGuard regions.

The lobby rules, the hotbar, the sidebar and everything else apply only to players inside a lobby area. The areas are in config.yml under areas, and the Areas card of /lobbyadmin edits them in game.

areas:
  worlds:
    - world
  boxes:
    spawn-box:
      world: survival
      min: '-50 0 -50'
      max: '50 255 50'
  worldguard-regions:
    - lobby
KeyWhat it is
worldsWhole worlds that are lobby. On a dedicated hub, list its world here. Default world.
boxesCuboids inside other worlds, such as the spawn of a survival server. Each has a world and two corners, min and max, as 'x y z'.
worldguard-regionsWorldGuard region ids that count as lobby. Needs WorldGuard.

A player is in the lobby while inside any of them.

How crossings are noticed

Worlds and boxes are ExyliaLib regions, so walking across an edge, a teleport, a world change and Folia's unreported moves are all caught. WorldGuard regions have no events and are checked twice a second, and only while some are configured.

Entering fires a LobbyEnterEvent and every module's enter runs; leaving fires a LobbyLeaveEvent and every module gives back what it changed. Editing the areas, a reload, or switching a module on or off moves everyone affected through the same path, so nobody is left holding lobby state.

Something missing on this page? Tell us on Discord