WarpUtils
A fully customizable teleportation utility mod for server-side features like tpa requests or homes
Introduction
WarpUtils is a lightweight, fully configurable server-side utility mod that provides essential teleportation features: Homes, Warps, and TPA requests. Inspired by the VanillaTweaks Datapacks.
Because it is server-side only, you can install this on your server and pure vanilla clients can join without any drawbacks or additional downloads.
Core Functionality
- Homes: Players can set personal waypoints and teleport back to them.
- Warps: Operators can set global waypoints (like shops or hubs) accessible to everyone.
- TPAs: Players can send requests to teleport to one another securely.
- Back: A convenient command to return to your previous location after a teleport.
Features
Every teleportation feature comes with
- Cooldowns: Configure how long a player must wait after teleporting before they can use the command again.
- Warm-up Delays: Configure a "stand-still" timer before a teleport executes. This delay will be cancelled if the player moves, runs another command, or is attacked (if the fight cooldown is active).
- Configurable: Every feature can be individually disabled and configured (see configuration details below).
Homes
Allows players to set personal homes and teleport back to them at will. Server owners can configure the maximum number of homes a player is allowed to keep.
| Command | Description |
|---|---|
/home <homeName> | Teleports you to the specific home |
/home | Teleports you to your default home (auto-selects one if no default is set) |
/setdefaulthome <homeName> | Sets an existing home as your default |
/sethome <homeName> | Creates or overwrites a home at your current location |
/delhome <homeName> | Deletes the specified home |
/renamehome <currentName> <newName> | Renames an existing home (can also override if the newName already exists) |
/homes | Lists all your saved homes and their coordinates |
TPAs (Teleport Requests)
Allows players to request teleportation to other players. The requesting player is teleported to the receiving player once they accept the request.
Note: A player can only have one outgoing request active at a time, but can receive multiple incoming requests. Cooldowns apply after the teleport happens; delays apply after the request is accepted.
| Command | Description |
|---|---|
/tpa <target> | Sends a teleport request to the specified player |
/tpaaccept <player> | Accepts a request from a specific player |
/tpaaccept | Accepts the most recent teleport request. |
/tpadeny <player> | Denies a request from a specific player |
/tpadeny | Denies all active incoming requests |
/tpacancel | Cancels the outgoing request you sent |
/tpas | Displays all active sent and received requests |
Warps
Allows operators to manage global points of interest that all players can teleport to.
The Spawn Warp:
By default, a Spawn warp is enabled and linked to the world spawn point (can be set using /setworldspawn ...)
- It can be detached from the world spawn by overwriting it:
/setwarp Spawn - It can be reattached to the world spawn by deleting the custom warp:
/delwarp Spawn
| Command | Description |
|---|---|
/warp <warpName> | Teleports you to the specified global warp |
/warps | Lists all available warps and their locations |
/setwarp <warpName> | (OP) Creates or overwrites a warp at your location |
/delwarp <warpName> | (OP) Deletes the specified warp |
/renamewarp <currentName> <newName> | (OP) Renames an existing warp |
Commands marked with (OP) can only be executed by the
Back Command
Allows players to return to the location they were at before their last teleport. The behavior is highly customizable via the config (including mode and duration settings).
| Command | Description |
|---|---|
/back | Teleports you back to your last location before a teleport |
Player Preferences & Effects
Personalize your experience using: /warputils personal <preference> ...
Customizable Options:
- Language: Set your display language (currently supports English).
- Message Target: Choose where mod messages appear:
chatoractionbar(Some messages may be forced to be displayed in one or the other, e.g. homes list). - Particles: Adjust the visual effects of the teleportation.
Visual Effects
Particles are displayed at three stages:
- Charge Effect: During the warm-up delay.
- Departure: At the location you leave.
- Arrival: At your destination.
Note: Operators can force effects to be enabled globally, overriding player preferences.
Configuration
Note: The config file is not for direct configuration. It only sets the default values used when creating a world or resetting the world specific config using /warputils config reset, /warputils config <category> reset or /warputils config <category> <setting> default.
The command /warputils config <category> allows you to easily configure the functionality of each feature as an operator. Non-operators may read the values of the config but not edit them.
General
This config category allows you to set more general configurations, like the default `messageTarget` or the `cooldown` and `delay` used for teleporation. Each features inherits the `cooldown` and `delay` values by default (the respective setting's value is set to -1) but they can be set individually using `/warputils configAccessed using /warputils config general <setting> <value>.
| Setting | Default | Description |
|---|---|---|
cooldown | 1200 | The waiting period (in ticks) between teleportations |
delay | 60 | The time (in ticks) between executing the command and being teleported |
messageTarget | actionbar | The primary location to display messages to |
ticks: 1 tick = 1/20th of a second
Homes
Accessed using `/warputils config homes| Setting | Default | Description |
|---|---|---|
maxHomeCount | 3 | The maximum number of homes a player can have (0 = Infinity) |
disableHomes | false | Disables homes (homes won't be deleted) |
Tpas (Teleport Requests)
Accessed using `/warputils config tpas| Setting | Default | Description |
|---|---|---|
duration | 6000 | The time (in ticks) a tpa request is active (0 = Infinity) |
disableTpas | false | Disables tpas |
ticks: 1 tick = 1/20th of a second
Warps
Accessed using `/warputils config warps| Setting | Default | Description |
|---|---|---|
disableSpawnWarp | false | Is the spawn warp disabled |
disableWarps | false | Disables warps (warps won't be deleted) |
Back Command
Accessed using `/warputils config back| Setting | Default | Description |
|---|---|---|
duration | 0 | The time (in ticks) a tpa request is active (0 = Infinity) |
mode | backBack | The operation mode of the /back command |
disableBack | false | Disables the /back command |
The operation modes the /back command:
- backBack: You can teleport back to the location you used
/back,/home,/tpaor/warpfrom - singleUse: You can teleport back once after every teleportation using
/home,/tpaor/warp - persistent: The back location only changes when using
/home,/tpaor/warp
Effects
Accessed using `/warputils config effects| Setting | Default | Description |
|---|---|---|
chargeEffect | RisingRings | The default effect to display during the delay period |
enforceChargeEffect | false | Enforces the default charge effect; always plays this effect instead of the effect the player selected |
teleporationEffect | Smoke | The default effect to display at the location of departure |
enforceTeleportEffect | false | Enforces the default teleportation effect; always plays this effect instead of the effect the player selected |
arrivalEffect | Smoke | The default effect to display at the location of arrival |
enforceArrivalEffect | false | Enforces the default arrival effect; always plays this effect instead of the effect the player selected |
disableEffects | false | Disables all particle effects in this mod |
Note: To disable one specific effect, select the "None" effect and enforce it.
Fight Cooldown
Accessed using `/warputils config fightCooldown| Setting | Default | Description |
|---|---|---|
cooldown | 60 | The duration during which you cannot teleport after being attacked |
onlyPvP | false | Whether only players can trigger this cooldown |
Note: To disable this feature set the cooldown to 0.
Note:
Feel free to share any ideas you want to be added to the mod or any changes you might like on my github issues page.
