RandomSpawn

From aquila
Jump to navigation Jump to search

RandomSpawn Plugin Documentation

Custom directional spawn selection and one-time friend teleportation systems for onboarding new players across AquilaPRJ.

What RandomSpawn Does

RandomSpawn allows new players to choose their starting region rather than crowding a single spawn point, while providing a temporary helper teleport to connect with friends.

  • Directional Spawn Menu: Presents a selection menu on a player's first join (or if unselected) to pick a cardinal direction.
  • Safe Location Search: Locates a secure spot in the chosen direction while avoiding water, lava, and world spawn boundaries.
  • Permanent Respawn Lock: Permanently binds that chosen coordinate as the player's personal respawn point.
  • One-Time Friend TP: Offers a single-use command allowing new players to teleport directly to an online friend and move their respawn point.

Choosing Your Spawn

Upon your first join, you will encounter the "Choose Your Spawn" menu containing five distinct paths:

<thead> </thead> <tbody> </tbody>
Option Description
North (red banner) Spawns you somewhere to the north.
South (green banner) Spawns you somewhere to the south.
East (blue banner) Spawns you somewhere to the east.
West (yellow banner) Spawns you somewhere to the west.
Random (compass) Spawns you in a completely randomized direction.

Selection is mandatory; closing the menu or dying before a choice is made forces the interface to reappear. Once a selection is locked in, it becomes permanent for your account and will never prompt again.

Friend TP

New players are granted one free teleport to bridge the gap with friends using the following command:

/friendtp <player>

  • Instant Teleportation: Moves you directly to the target player, who must currently be online.
  • Respawn Update: Automatically relocates your personal respawn point to that destination.
  • Strict Limits: Usable only once per account, restricted to the first 7 days following your initial join before expiration. Self-targeting is blocked.

Server Configuration

Server administrators can modify plugin parameters in the configuration file:

<thead> </thead> <tbody> </tbody>
Setting Default Description
spawn.world world Specifies the target game world for player spawning.
spawn.minimum-radius 1000 Minimum distance from world spawn a player can land.
spawn.maximum-radius 10000 Maximum distance from world spawn a player can land.
spawn.max-attempts 50 Safe location generation retry limit before falling back to world spawn.
friendtp.enabled true Toggles availability of the Friend TP command.
friendtp.duration-days 7 Expiration window in days following first join.