FeatherTP
A super lightweight Random TP plugin that follows the philosophy of "Do one thing, and do it well"
📖About FeatherTP
FeatherTP (Feather Teleport)
FeatherTP is a Minecraft plugin that allows players to randomly teleport to safe locations within the Minecraft world. This plugin is lightweight and easy to use, making it ideal for servers that want to add random teleportation features without impacting server performance.
Features
- Random teleportation to safe locations
- Configurable teleportation range and center position
- Cooldown settings between teleportations
- Support for multiple worlds (world_nether, world_the_end, etc.)
- Reload command to reload the configuration
Installation
- Download the
.jarfile from Releases. - Place the
.jarfile into thepluginsfolder on your Minecraft server. - Restart your Minecraft server.
Usage
To use FeatherTP, follow these steps:
Random Teleport Command
Players can use the/rtpcommand to randomly teleport to a safe location. Additionally, the plugin supports aliases such as/tprand/ltp.
Example:/rtp /tpr /ltpAdmin Commands
- Reload the plugin configuration:
This command reloads the/feathertp reloadconfig.ymlfile without restarting the server.
- Reload the plugin configuration:
Permissions
feathertp.use: Allows players to use the/rtp,/tpr, and/ltpcommands.feathertp.admin: Grants access to admin commands like/feathertp reload.
Make sure to configure permissions in your server's permission management plugin (e.g., LuckPerms) to control access to these commands.
Configuration
This plugin uses a config.yml file for configuration. Below is an example configuration structure:
permissions:
require-use-permission: true # If true, only players with the `feathertp.use` permission can use /rtp
world:
teleport:
random:
minRange: 100 # Minimum range for teleportation
maxRange: 1000 # Maximum range for teleportation
centerX: 0 # X-coordinate of the teleportation center
centerZ: 0 # Z-coordinate of the teleportation center
maxTries: 10 # Number of attempts to find a safe location
cooldownSeconds: 30 # Cooldown in seconds between teleportations
Building/Compiling
To build the FeatherTP plugin from source, follow these steps:
Clone the Repository
Clone the FeatherTP repository to your local machine:git clone https://github.com/Lightnabz/FeatherTP.git cd FeatherTPEnsure Prerequisites
Make sure you have the following installed:- Java Development Kit (JDK) (version 21 or higher)
- Maven
Build the Plugin
Use Maven to compile the plugin and package it into a.jarfile:mvn clean packageLocate the Output
After the build process completes, the.jarfile will be located in thetargetdirectory.
You can now use the generated .jar file as described in the Installation section.