Unstuck - Person8880/Shine GitHub Wiki

Overview

The unstuck plugin provides players with a way to get out of world geometry they are stuck inside.

Config

The default config file should look something like this:

{
    "DelayBeforeMovingInSeconds": 0,
    "DistanceToCheck": 6,
    "MinTimeInSeconds": 5,
    "MovementToleranceDistance": 0.5,
    "TimeBetweenUseInSeconds": 30,
    "__Version": "1.2"
}

The file should be called "Unstuck.json" and should be placed in the directory defined as your plugin config directory (default is config://shine/plugins).

Option	Description
DelayBeforeMovingInSeconds	How long to force players to remain stationary after using the unstuck command before they will be moved.
DistanceToCheck	Determines how far around the player to look for a spawn location.
MinTimeInSeconds	Determines how long (in seconds) a player must wait between failed unstuck attempts.
MovementToleranceDistance	Determines the maximum distance a player can move after requesting to be unstuck without it failing.
TimeBetweenUseInSeconds	Determines how long (in seconds) a player must wait between successful uses of the unstuck command before being able to use it again.

Commands

Command	Chat Command	Arguments	Description
sh_unstuck	!unstuck or !stuck	N/A	Attempts to free the given player from world geometry.