RandomSpawn: Difference between revisions

From aquila
Jump to navigation Jump to search
Created page with "RandomSpawn gives every new player a choice of where in the world they start, instead of dropping everyone at the same spawn point. It also includes a one time "Friend TP" command so new players can quickly join a friend who's already playing. == What RandomSpawn Does == * On your '''first join''' (or if you haven't finished choosing a spawn yet), you're shown a menu to pick which direction of the world you want to spawn in * Finds a '''safe location''' in that directi..."
 
mNo edit summary
 
Line 1: Line 1:
RandomSpawn gives every new player a choice of where in the world they start, instead of dropping everyone at the same spawn point. It also includes a one time "Friend TP" command so new players can quickly join a friend who's already playing.
__NOTOC__
<div style="background: linear-gradient(135deg, #0b132b 0%, #1c2541 50%, #3a506b 100%); border: 2px solid #e0a96d; border-radius: 12px; padding: 2.5em 1.5em; text-align: center; color: #ffffff; box-shadow: 0 4px 20px rgba(0,0,0,0.3); margin-bottom: 2em;">
<h1 style="border: none; color: #f4a261; font-family: 'Georgia', serif; font-size: 2.3em; margin: 0 0 0.3em 0; padding: 0; text-shadow: 0 2px 4px rgba(0,0,0,0.5);">RandomSpawn Plugin Documentation</h1>
<p style="font-size: 1.1em; color: #e0e1dd; max-width: 650px; margin: 0 auto; line-height: 1.5;">Custom directional spawn selection and one-time friend teleportation systems for onboarding new players across AquilaPRJ.</p>
</div>


== What RandomSpawn Does ==
<div style="background: #ffffff; border: 1px solid #d1d5db; border-radius: 8px; padding: 1.5em; box-shadow: 0 2px 4px rgba(0,0,0,0.05); margin-bottom: 2em;">
<h2 style="border-bottom: 2px solid #e0a96d; color: #0b132b; margin-top: 0; padding-bottom: 0.3em; font-family: 'Georgia', serif;">What RandomSpawn Does</h2>
<p style="line-height: 1.6; color: #374151; margin-bottom: 1em;">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.</p>
<ul style="color: #374151; line-height: 1.6; margin-top: 0; padding-left: 1.5em;">
<li><b>Directional Spawn Menu:</b> Presents a selection menu on a player's first join (or if unselected) to pick a cardinal direction.</li>
<li><b>Safe Location Search:</b> Locates a secure spot in the chosen direction while avoiding water, lava, and world spawn boundaries.</li>
<li><b>Permanent Respawn Lock:</b> Permanently binds that chosen coordinate as the player's personal respawn point.</li>
<li><b>One-Time Friend TP:</b> Offers a single-use command allowing new players to teleport directly to an online friend and move their respawn point.</li>
</ul>
</div>


* On your '''first join''' (or if you haven't finished choosing a spawn yet), you're shown a menu to pick which direction of the world you want to spawn in
<div style="background: #ffffff; border: 1px solid #d1d5db; border-radius: 8px; padding: 1.5em; box-shadow: 0 2px 4px rgba(0,0,0,0.05); margin-bottom: 2em;">
* Finds a '''safe location''' in that direction (avoiding water, lava, and the area right around world spawn)
<h2 style="border-bottom: 2px solid #e0a96d; color: #0b132b; margin-top: 0; padding-bottom: 0.3em; font-family: 'Georgia', serif;">Choosing Your Spawn</h2>
* Permanently sets that location as your '''respawn point'''
<p style="line-height: 1.6; color: #374151; margin-bottom: 1em;">Upon your first join, you will encounter the <b>"Choose Your Spawn"</b> menu containing five distinct paths:</p>
* Gives new players a '''one time Friend TP''' command to instantly teleport to an online friend and move their spawn point there instead


== Choosing Your Spawn ==
<table class="wikitable" style="width: 100%; border-collapse: collapse; margin-bottom: 1em;">
The first time you join the server, you'll be shown a menu titled '''"Choose Your Spawn"''' with five options:
<thead>
{| class="wikitable"
<tr style="background: #f1f5f9; text-align: left;">
|+
<th style="padding: 0.75em; border: 1px solid #cbd5e1; color: #0b132b; width: 30%;">Option</th>
!Option
<th style="padding: 0.75em; border: 1px solid #cbd5e1; color: #0b132b;">Description</th>
!What it does
</tr>
|-
</thead>
|'''North''' (red banner)
<tbody>
|Spawns you somewhere north
<tr>
|-
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><b>North</b> (red banner)</td>
|'''South''' (green banner)
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Spawns you somewhere to the north.</td>
|Spawns you somewhere south
</tr>
|-
<tr style="background: #f8fafc;">
|'''East''' (blue banner)
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><b>South</b> (green banner)</td>
|Spawns you somewhere east
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Spawns you somewhere to the south.</td>
|-
</tr>
|'''West''' (yellow banner)
<tr>
|Spawns you somewhere west
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><b>East</b> (blue banner)</td>
|-
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Spawns you somewhere to the east.</td>
|'''Random''' (compass)
</tr>
|Spawns you in a random direction
<tr style="background: #f8fafc;">
|}
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><b>West</b> (yellow banner)</td>
Click one to be teleported there right away. '''You must choose one to continue'''. if you close the menu without picking, it will pop back open. If you die and respawn before making a choice, you'll also be shown the menu again.
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Spawns you somewhere to the west.</td>
</tr>
<tr>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><b>Random</b> (compass)</td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Spawns you in a completely randomized direction.</td>
</tr>
</tbody>
</table>


Once you've picked a spawn, that choice is permanent for your account! it '''won't ask again.'''
<p style="line-height: 1.6; color: #374151; margin-bottom: 0;">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.</p>
</div>


== Friend TP ==
<div style="background: #ffffff; border: 1px solid #d1d5db; border-radius: 8px; padding: 1.5em; box-shadow: 0 2px 4px rgba(0,0,0,0.05); margin-bottom: 2em;">
New players get '''one free teleport''' to any other online player, as a quick way to link up with friends.
<h2 style="border-bottom: 2px solid #e0a96d; color: #0b132b; margin-top: 0; padding-bottom: 0.3em; font-family: 'Georgia', serif;">Friend TP</h2>
<p style="line-height: 1.6; color: #374151; margin-bottom: 1em;">New players are granted one free teleport to bridge the gap with friends using the following command:</p>
<p style="margin-bottom: 1em;"><code>/friendtp &lt;player&gt;</code></p>
<ul style="color: #374151; line-height: 1.6; margin-top: 0; padding-left: 1.5em;">
<li><b>Instant Teleportation:</b> Moves you directly to the target player, who must currently be online.</li>
<li><b>Respawn Update:</b> Automatically relocates your personal respawn point to that destination.</li>
<li><b>Strict Limits:</b> Usable only once per account, restricted to the first 7 days following your initial join before expiration. Self-targeting is blocked.</li>
</ul>
</div>


<code>/friendtp <player></code>
<div style="background: #ffffff; border: 1px solid #d1d5db; border-radius: 8px; padding: 1.5em; box-shadow: 0 2px 4px rgba(0,0,0,0.05); margin-bottom: 2em;">
<h2 style="border-bottom: 2px solid #e0a96d; color: #0b132b; margin-top: 0; padding-bottom: 0.3em; font-family: 'Georgia', serif;">Server Configuration</h2>
<p style="line-height: 1.6; color: #374151; margin-bottom: 1em;">Server administrators can modify plugin parameters in the configuration file:</p>


* Teleports you directly to the named player (they must be online)
<table class="wikitable" style="width: 100%; border-collapse: collapse;">
* Sets your respawn point to that location
<thead>
* Can only be used '''once per player''', and only within the first '''7 days''' after your first join, after that, it expires
<tr style="background: #f1f5f9; text-align: left;">
* You can't use it on yourself
<th style="padding: 0.75em; border: 1px solid #cbd5e1; color: #0b132b; width: 30%;">Setting</th>
<th style="padding: 0.75em; border: 1px solid #cbd5e1; color: #0b132b; width: 20%;">Default</th>
<th style="padding: 0.75em; border: 1px solid #cbd5e1; color: #0b132b;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><code>spawn.world</code></td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><code>world</code></td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Specifies the target game world for player spawning.</td>
</tr>
<tr style="background: #f8fafc;">
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><code>spawn.minimum-radius</code></td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">1000</td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Minimum distance from world spawn a player can land.</td>
</tr>
<tr>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><code>spawn.maximum-radius</code></td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">10000</td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Maximum distance from world spawn a player can land.</td>
</tr>
<tr style="background: #f8fafc;">
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><code>spawn.max-attempts</code></td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">50</td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Safe location generation retry limit before falling back to world spawn.</td>
</tr>
<tr>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><code>friendtp.enabled</code></td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">true</td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Toggles availability of the Friend TP command.</td>
</tr>
<tr style="background: #f8fafc;">
<td style="padding: 0.75em; border: 1px solid #cbd5e1;"><code>friendtp.duration-days</code></td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">7</td>
<td style="padding: 0.75em; border: 1px solid #cbd5e1;">Expiration window in days following first join.</td>
</tr>
</tbody>
</table>
</div>


Once used (or expired), the command will tell you it's no longer available.
== Server Configuration ==
{| class="wikitable"
|+
!Setting
!Default
!What it controls
|-
|spawn.world
|<code>world</code>
|Which world players are spawned into
|-
|spawn.minimum-radius
|1000
|Closest distance from world spawn a player can land
|-
|spawn.maximum-radius
|10000
|Farthest distance from world spawn a player can land
|-
|spawn.max-attempts
|50
|How many times the plugin tries to find a safe spot before falling back to world spawn
|-
|friendtp.enabled
|true
|Whether the Friend TP command is available
|-
|friendtp.duration-days
|7
|How many days after first join Friend TP remains usable
|}
[[Category:Plugins]]
[[Category:Plugins]]

Latest revision as of 13:10, 22 August 2026

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.