Worlds

/worlds is a full multi-world manager: create a world, import one that is already on disk, load and unload it, tune its properties and gamerules, set its spawn, and move players into it, without editing bukkit.yml or restarting. The bare command opens the world list, and picking a world opens its editor.

Module worlds · enabled by default · modules/worlds/config.conf

Commands

Permissions

Settings

Placeholders

Notes

• /worlds manages, /world reports. The plural command is this module; the singular one is a player-state info command that names the world you are standing in.

• import registers a folder in place, regenerating nothing, which is how a downloaded map or a world from another plugin joins the roster. /uxmess import multiverse does the whole Multiverse-Core registry at once.

• Two generators ship beyond the vanilla types: void for an empty world and flat for a superflat one.

• The default world can use them too. /world create is the usual way in, but the world the server starts with is made before any command can run, so it is configured in bukkit.yml instead:

  worlds:
    world:
      generator: uxmEssentials:void
  

  This works from 0.8.3 on. Earlier versions logged Plugin 'uxmEssentials' is not enabled yet (is it load:STARTUP?) and generated normal terrain, because the server builds the default world before the plugin had enabled. If the worlds module is off, or the id after the colon is not void or flat, the world still generates as normal terrain and the reason is now written to the log.

  One consequence is worth planning for: a world pointed at our generator falls back to whatever server.properties describes if the plugin ever fails to enable. Keep level-type and the rest of that file set to something you would accept seeing, because that is the world your players land in on a bad boot.

• Access is not automatic. The access block gates a world behind a permission and can charge an entry fee through the economy, which is how a paid event map or a premium world is built with no extra plugin.

• A world can catch players who fall out of it. Set void-rescue on a world and anybody who drops into the void there is moved instead of dying. The value is an ordered list of steps separated by ;, and the first one that resolves wins:

  Step	Sends the player to
  spawn	the spawn /spawn would use for that world
  warp:<name>	a server warp
  at:<world>,<x>,<y>,<z>	exact coordinates, optionally ,<yaw>,<pitch>

  /worlds set lobby void-rescue spawn
  /worlds set event void-rescue warp:arena;spawn
  /worlds set parkour void-rescue at:parkour,0.5,80,0.5,180,0
  

  By default the catch happens when the void starts hurting the player. Set void-rescue-y as well to catch them earlier, at a height of your choosing (/worlds set lobby void-rescue-y -10), so they never see the bottom of the fall. Clear either setting by passing an empty value. Spectators are never moved, nor is anybody holding uxmessentials.world.voidrescue.exempt. If the destination is itself in the void the rescue would loop, so after three rescues in ten seconds the player is left to fall and a warning is written to the console.

• Portals wire worlds together so players walk between them instead of typing a command; a portal honours the same access gate and fee. It also honours the server's own policy: with allow-nether or allow-end off in server.properties, that portal is refused before any configured link is looked at.

• Deleting and restoring are two-step. Both ask for a confirm command, so a live world cannot be lost to a mistyped name. Snapshots land in backup.directory and are pruned to backup.retention-count.

• Pre-generation is paced, not blocking. pregen <name> <radius> walks the world outward under max-concurrent-chunks and tick-period-ticks, and pregen cancel stops it.

• Auto-unload is off by default. Switched on, a world with no players is unloaded after idle-minutes, skipping anything in excluded-worlds.

Related: Teleport, Regions, Menus