TeleportMe - Speedgot

TeleportMe -----

A Light Weight Teleport Plugin For All Your Warps, Homes & Deaths

TeleportMe, is a plugin based around simplicity and user experience. The main focus of the plugin is to give players the ability to teleport in a whole range of ways, as well as allowing for some quality of life improvements. Such as;

- Random teleport
- Returning to previous location
- Teleporting to their death location
- And Much Much More!!!

Full Feature list

Code (Text):

- Random teleport
- Returning to previous location
- Teleporting to their death location[/B]
- Displaying their co-ordinates & biome
- Creating one time teleports
- Teleporting to said one time teleports
- Setting home's with custom names
- Returning to homes
- Deleting Homes
- Listing Currently Saved Homes
- Creating Public Warps
- Listing All Public Warps
- And lastly reloading the plugin config file

Main Features
As previously stated, the plugins main focus revolves around teleportation. As well as being able to teleport in the ways stated above, the player can also check their coordinates & biome with one simple command

Commands
/tpme [random, temp, gotemp, death, coords, reload] - Allows the player to randomly teleport.

/home [set, go, list, delete, reload] - Allows the player to do home related commands

/warp [set, go, list, delete, reload] - Allows the player to do warp related commands

Permissions
To allow for maximum customization, I've created new permissions for each command. These permissions can be used to allow or deny players access to their relative commands.

player.TPME
player.GoBack
player.TpDeath
player.Coords
player.TMP
player.TPTemp
player.SetHome
player.GoHome
player.ConfigReload
player.SetWarp
player.GoWarp
player.UpdateWarning - Warns Player About Renewing CFG After Update
player.ListHomes
player.ListWarps
player.DelHome

Configuration
When creating the config file, I looked towards ease of use, as well as compatibility. This is because there are a whole host of plugins out there so by making my plugin as compatible as possible, it should play nice with others.

When using the config file, each section is clearly marked with comments, shown by #, to give the user an indepth explanation of how to use it correctly.

As well as this, I've allowed the user to enable and disable each command, to once again allow for maximum compatibility. Also included within the config file, is the ability to toggle the ingame chat messages that accopany each command.

Finally, I have taken the time to allow the user to customize many aspects of the plugin's ingame appearence through the config. For example the player can now change or remove the plugin's message prefix, as well as change the colour of it and messages excluding error messages. This once again show's the added support and depth of the plugin, as well as how dedicated I am to making it as seemless as possible.

Please look @ the spoiler for an example config file

Config File

Code (Text):

# _______ _ _ __ __
# |__ __| | | | | | \/ |
# | | ___| | ___ _ __ ___ _ __| |_ | \ / | ___
# | |/ _ \ |/ _ \ '_ \ / _ \| '__| __| | |\/| |/ _ \
# | | __/ | __/ |_) | (_) | | | |_ | | | | __/
# |_|\___|_|\___| .__/ \___/|_| \__| |_| |_|\___|
# | |
# |_|

# v1.7

######################
####Customization#####
######################

# Colours can be found here:
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/ChatColor.html

# Changes plugins prefix in chat

Prefix: "[TPME] "

# Changes colour of plugins prefix

PrefixColour: "WHITE"

# Changes colour of chat message

MessageColour: "GREEN"

# Set Maximum Radius For Random Teleport

MaxDistance: 10000

##################
##Command On/Off##
##################

## Teleport Commands ##

# Enables All Teleport Commands
# Eg; true = On / false = off
TeleportsEnabled: true

# Toggles tpme Command
# Eg; true = On / false = off

TpmeEnabled: true

# Toggles goback Command
# Eg; true = On / false = off

GobackEnabled: true

# Toggles tpdeath Command
# Eg; true = On / false = off

TpdeathEnabled: true

# Toggles coords Command
# Eg; true = On / false = off

CoordsEnabled: true

# Toggles tmp Command
# Eg; true = On / false = off

TmpEnabled: true

# Toggles tptemp Command
# Eg; true = On / false = off

TPTempEnabled: true

# Toggles savetemptp Command
# Eg; true = On / false = off
SaveTmpTpEnabled: true

## Home Commands ##

# Enables The Whole Set Of Home Commands
# Eg; true = On / false = off
HomesEnabled: true

# Toggles sethome Command
# Eg; true = On / false = off
SetHomeEnabled: true

# Toggles home Command
# Eg; true = On / false = off
GoHomeEnabled: true

# Toggles delete home command
# Eg; true = On / false = off
DelHomeEnabled: true

## Warp Commands ##

# Enables The Whole Set Of Warp Commands
# Eg; true = On / false = off
WarpsEnabled: true

# Toggles setwarp command
# Eg; true = On / false = off
SetWarpEnabled: true

# Toggles warp command
# Eg; true = On / false = off
GoWarpEnabled: true

## Misc Commands ##

# Toggles cfgreload command
# Eg; true = On / false = off
CFGReloadEnabled: true

#################
##Chat Messages##
#################

#######################
## Teleport Messages ##
#######################

# Displays How Far A User Has Teleported
# Eg; Teleport Successful, You have travelled "[Insert Number]" Blocks Away From Your Previous Location.

TeleportDistance: true

# Displays Teleport Success / Failure When Going Back To A Previous location
# Eg; Teleport Successful, You have travelled back to your original location.
# Eg; You have no previous teleport locations.

DisplaySuccess: true

# Tells Player Upon Death That Their Location Has Been Saved
# Eg; Your death location has been saved, do /tpdeath to retrun to it.

AnnounceDeathloc: true

# Disaplays Death Location Success / Failure
# Eg; Returned to death location.
# Eg; You have no previous death locations.

DisplayDeathloc: true

# Disaplays Players Coordinates & Biome
# Eg; [X],[Y],[Z],[Biome]

DisplayCoords: true

# Display Message For Temporary Location Save

TmpSaved: true

# Display Message For Temporary Teleport Used

TPTemp: true

# Displays Safe Teleport Message

SafeTeleport: true

###################
## Home Messages ##
###################

# Displays Message For Set Home

DisplayHomeSet: true

# Displays Message When Player Has No Home

NoHome: true

# Displays Message When Player Has Gone Home

GoHome: true

# Displayed Message When Home Has Been Deleted

DelHome: true

###################
## Warp Messages ##
###################

# Displays Warp Set Message
DisplayWarpSet: true

# Disaplays Message When Player Has Warped

GoWarp: true

# Displayes Message When Player Has No Warp Selected

NoWarp: true

# Displayes Message When Warp Has Been Deleted

DelWarp: true

###################
## Misc Messages ##
###################

# Displays Update Warning Message When Player [With Perms] Connects

DisplayUpdateWarning: true

###############
##Permissions##
###############

# player.TPME

# Allows The Player To Use /tpme
# To Tp To A Random location

# player.GoBack

# Allows The Player To Use /goback
# To Tp Back To Their Last Location

# player.TpDeath

# Allows The Player To Use /tpdeath
# To Tp To Their Death Location

# player.Coords

# Allows The Player To Use /coords
# To View Their Coords & Biome

# player.TMP

# Allows The Player To Use /tmp
# To Create A Temporary Teleport

# player.TPTemp

# Allows The Player To Use /tptemp
# To Teleport To Their Temporary Teleport

# player.SetHome

# Allows Player To Use /sethome
# To Create A New Home Location

# player.GoHome

# Allows Player To Use /home
# To Return To Their Home Location

# player.ConfigReload

# Allows Player To Use /cfgreload
# To Reload The Main Config File

# player.SetWarp

# Allows Player To Set Warp Location

# player.GoWarp

# Allows Player To Warp To Defined Locations

# player.UpdateWarning

# Notifies Player To Renew Configs After Update

# player.ListHomes

# Allows Player To List Their Houses

# player.ListWarps

# Allows Player To List Warps

Ingame Screen Shots