SimpleTP

English | 简体中文

A simple teleportation plugin designed to create waypoints and implement the teleportation features of EssentialsX.

Preview

Features

• Support for personal waypoints that players can create and manage, visible only to themselves
• Support for global waypoints (public waypoints) visible to all players, suitable for public areas
• Configurable enabled dimensions with support for modded dimensions (like Twilight Forest, Eternal Starlight, etc.)
• Support for returning to death location and previous location before teleporting
• Most commands support clickable operations for convenience

Commands

The following examples use the default prefix "!!stp". Adjust according to your configuration file.

Personal Waypoints

• Create Personal Waypoint at Current Location: !!stp setp (-f?) <name>, where -f indicates to force overwrite an existing waypoint with the same name
• Teleport to Personal Waypoint: !!stp tpp <name>
• Delete Personal Waypoint: !!stp delp <name>
• List All Personal Waypoints: !!stp listp

Global Waypoints (Public Waypoints)

• Create Global Waypoint at Current Location: !!stp setg (-f?) <name>, where -f indicates to force overwrite an existing waypoint with the same name
• Teleport to Global Waypoint: !!stp tpg <name>
• Delete Global Waypoint: !!stp delg <name>
• List All Global Waypoints: !!stp listg

TP Commands

• Teleport to Player: !!stp tp <player>
• Teleport Player to Self: !!stp tphere <player>
• Request Teleport to Player: !!stp tpa <player>
• Request Player to Teleport to Self: !!stp tpahere <player>
• Cancel Teleport Request: !!stp cancel
• Accept Teleport Request: !!stp accept <player?>
• Deny Teleport Request: !!stp deny <player?>

Other Commands

• List All Waypoints (personal and global): !!stp list
• Return to Last Location: !!stp back (available after teleporting or upon death)

Configuration File

The configuration file is located at config/SimpleTP/config.json

• prefix: Command prefix, default is !!stp
• back_on_death: Whether to automatically record the position upon player death, default is true
• save_interval: Interval for scheduled saving of waypoint data, in seconds, default is 30 seconds
• permissions: Permission configuration
• worlds: List of supported dimensions (including mod dimensions), default is ["minecraft:overworld", "minecraft:the_nether", "minecraft:the_end"]. Teleportation will not work in dimensions not in this list. To disable teleportation in a dimension, simply remove it from the list.
• extra_dimensions: Only required for Minecraft versions before 1.16, configuration format is {<dimension_id>: "<dimension_name>"}, for example {0: "minecraft:overworld", 1: "minecraft:the_nether", 2: "minecraft:the_end"}. This configuration is used to support mod dimensions in older Minecraft versions.

Permission Configuration

• back: Permission to use !!stp back command
• tpa: Permission to use !!stp tpa command
• tpahere: Permission to use !!stp tpahere command
• tp: Permission to use !!stp tp <player> command
• tphere: Permission to use !!stp tphere <player> command
• personal_waypoint: Permission to set/delete personal waypoint related commands
• global_waypoint: Permission to set/delete global waypoint related commands
• cross_world_tp: Permission for cross-dimension teleportation

Dependencies

• minecraft_data_api: Used for retrieving player information
• mg_events: Used for listening to player death events

Common Issues

• Clickable Teleport Button Not Responding MCDR has issues with click execution support in higher MC versions. Install LetMeClickAndSendForServer (server-side) or LetMeClickAndSend (client-side).
• Sometimes back Command Doesn't Return to Previous Location After Death Some mod death messages are special and may not be detected by mg_events. You need to manually add corresponding death messages in mg_events language files. For example, for the Eternal Starlight mod, when players die in the Ether, add "death.attack.ether": "%1$s drifts away" to config/mg_events/lang/en_us.json, and "death.attack.ether": "%1$s飘然而去" to config/mg_events/lang/zh_cn.json.
• Log Shows "Player {player} is in a dimension not enabled in config: {dimension}" This indicates the player is in a dimension not enabled in the configuration. Check the worlds configuration in config/SimpleTP/config.json to ensure the dimension is included.
• Log Shows "Player {player} is in an unknown dimension with ID {dimension}" This error may occur when the server Minecraft version is before 1.16 and mod dimensions are installed. Check the extra_dimensions configuration in config/SimpleTP/config.json to ensure the dimension is included. You can get the dimension ID using the /data get entity <player> Dimension command.

TODO

If you have more feature requests or are interested in any planned features, feel free to raise them in the issues section 🚀 Sorted by priority:

• Support clickable waypoints
• back command supports round-trip teleportation
• Record player's dimension in waypoints (Nether, Overworld, End)
• Configuration for cross-dimension teleportation
• Scheduled saving of waypoint data (to prevent loss on crash)
• tp/tphere functionality
• tpa/tpahere functionality
• Add help information
• Record player's orientation in waypoints
• Add description information for waypoints
• Teleport cooldown configuration
• Maximum number of waypoints configuration
• Waypoint name length limit configuration
• Waypoint safety check, prompting confirmation or teleporting to nearby safe location if the waypoint is in a dangerous position
• Teleport cost configuration (consume custom items or experience) (base cost + distance cost)
• Multi-language support