Module: Spawn - Module ID: spawn

Introduction

The Spawn module allows the spawn point of each world to be set, as well as a “first spawn point”, that is, the location that new players will spawn at.

If no “first spawn point” is set (using /setfirstspawn), then new players will go to the default world’s spawn point.

/firstspawn
Module: spawn
If set, warp to the new player spawn point.

Aliases: firstspawn

Root command aliases: /nfirstspawn

Usage: /firstspawn

Default Role: USER

Basic Command Permission: nucleus.firstspawn.base

Permissions

  • nucleus.firstspawn.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /firstspawn
  • nucleus.firstspawn.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /firstspawn
  • nucleus.firstspawn.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /firstspawn
  • nucleus.firstspawn.base - Default Role: USER
    Allows the user to run the command /firstspawn
/setfirstspawn
Module: spawn
Sets the new player spawn point.

Aliases: setfirstspawn

Root command aliases: /nsetfirstspawn

Usage: /setfirstspawn

Available subcommands: del

Default Role: ADMIN

Basic Command Permission: nucleus.firstspawn.set.base

Permissions

  • nucleus.firstspawn.set.base - Default Role: ADMIN
    Allows the user to run the command /setfirstspawn
/setfirstspawn del
Module: spawn
Removes the new player spawn point.

Aliases: setfirstspawn del setfirstspawn rm

Usage: /setfirstspawn del

Default Role: ADMIN

Basic Command Permission: nucleus.firstspawn.remove.base

Permissions

  • nucleus.firstspawn.remove.base - Default Role: ADMIN
    Allows the user to run the command /setfirstspawn del
/setspawn
Module: spawn
Sets the current world spawn point.

Aliases: setspawn

Root command aliases: /nsetspawn

Usage: /setspawn

Default Role: ADMIN

Basic Command Permission: nucleus.setspawn.base

Permissions

  • nucleus.setspawn.base - Default Role: ADMIN
    Allows the user to run the command /setspawn

This command is an equivalent to the following command(s) in Essentials: /setspawn

/spawn
Module: spawn
Warp to a world spawn point.

If the global spawn world is set in the configuration, then calling /spawn without a world argument will send the calling player to the global spawn point, otherwise, the player will warp to the current world spawn point.

Aliases: spawn

Root command aliases: /nspawn

Usage: /spawn [-f|--force] [<world>]

Available subcommands: other

Default Role: USER

Basic Command Permission: nucleus.spawn.base

Permissions

  • nucleus.spawn.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /spawn
  • nucleus.spawn.worlds - Default Role: ADMIN
    If set in the main config, this permission will give players access to spawn in all worlds. Adding the name of the lowercase name world as a child of this permission will grant permission for that world only (that is, ending with "worlds.world" for the world "world").
  • nucleus.spawn.otherworlds - Default Role: ADMIN
    Allows the user to go to another world's spawnpoint.
  • nucleus.spawn.force - Default Role: ADMIN
    Allows the user to attempt to force teleportation to spawn.
  • nucleus.spawn.base - Default Role: USER
    Allows the user to run the command /spawn
  • nucleus.spawn.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /spawn
  • nucleus.spawn.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /spawn

This command is an equivalent to the following command(s) in Essentials: /spawn

/spawn other
Module: spawn
Warp another player to a world spawn point.

This works in a similar way to the /spawn command, though the command may be used against offline players if the calling entity has permission. If the player is offline, the system will warp them prior to joining the world on next login.

Aliases: spawn other

Usage: /spawn other <subject> [<world>]

Default Role: ADMIN

Basic Command Permission: nucleus.spawn.other.base

Permissions

  • nucleus.spawn.other.offline - Default Role: ADMIN
    Allows the user to send a player to spawn on their next login.
  • nucleus.spawn.other.base - Default Role: ADMIN
    Allows the user to run the command /spawn other
Permission Suggested Role Description
nucleus.firstspawn.base USER Allows the user to run the command /firstspawn
nucleus.firstspawn.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /firstspawn
nucleus.firstspawn.exempt.cost ADMIN Allows the user to bypass the cost for /firstspawn
nucleus.firstspawn.exempt.warmup ADMIN Allows the user to bypass the warmup for /firstspawn
nucleus.firstspawn.remove.base ADMIN Allows the user to run the command /setfirstspawn del
nucleus.firstspawn.set.base ADMIN Allows the user to run the command /setfirstspawn
nucleus.setspawn.base ADMIN Allows the user to run the command /setspawn
nucleus.spawn.base USER Allows the user to run the command /spawn
nucleus.spawn.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /spawn
nucleus.spawn.exempt.cost ADMIN Allows the user to bypass the cost for /spawn
nucleus.spawn.exempt.login ADMIN If granted, and the configuration is set to send players to spawn on login, this permission will prevent the player from going to spawn on login.
nucleus.spawn.exempt.warmup ADMIN Allows the user to bypass the warmup for /spawn
nucleus.spawn.force ADMIN Allows the user to attempt to force teleportation to spawn.
nucleus.spawn.other.base ADMIN Allows the user to run the command /spawn other
nucleus.spawn.other.offline ADMIN Allows the user to send a player to spawn on their next login.
nucleus.spawn.otherworlds ADMIN Allows the user to go to another world's spawnpoint.
nucleus.spawn.worlds ADMIN If set in the main config, this permission will give players access to spawn in all worlds. Adding the name of the lowercase name world as a child of this permission will grant permission for that world only (that is, ending with "worlds.world" for the world "world").
The following configuration is the default for this module:
# If true, if a respawn would be back to a bed, Nucleus will override that, if false, Nucleus will ignore bed spawns.
affect-bed-spawn=true
# If true, then Nucleus will attempt to force players joining for the first time to spawn at the *direct point* that first spawn has been set.
# Only set this if you want Nucleus to override all other plugins on first spawn.
force-first-spawn=false
# This section controls whether respawning and /spawn work on a per world or global server basis
global-spawn {
    # If "spawn-on-login" is on and this is true, sends the player to the world specified in "target-spawn-world" when they log in.
    on-login=false
    # If true, respawning (like from death) sends the player to the world specified in "target-spawn-world", if false, sends them to the world spawn.
    on-respawn=false
    # If true, running /spawn sends the player to the world specified in "target-spawn-world", if false, sends them to the world spawn.
    on-spawn-command=false
    # The name of the world to use as the server spawn. If this is invalid, the default world is used instead.
    target-spawn-world=world
}
# If true, players require the permission "nucleus.spawn.worlds.<worldname>" to spawn in a specific world, where worldname is the name of the world in lowercase.
per-world-permissions=false
# If true, players will be sent to the default world spawn on login, unless they are sent to the first login spawn, or they have the "nucleus.spawn.exempt.login" permission.
spawn-on-login=false
# If "spawn-on-login" is true, if a player logs in and is on any of the worlds listed here, they will NOT be redirected to the spawn point.
# 
# This supports both world names and world UUIDs.
spawn-on-login-exempt-worlds=[]
# If true, using /spawn will attempt to find a safe place. If false, the teleportation will always directly send the player to the location with no safety checks.
use-safe-spawn=true