Skip to content

About

An easy-to-use Fabric Teleport and Portal Mod: Homes, Warps, Portals, Back, Spawn and TPA; Usable with rides; Server- and/or client-side; Minimal pre-defined configuration!

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Public Teleport Banner

An easy-to-use Fabric Teleport and Portal Mod!

  • Homes, Warps, Portals, Back, Spawn and TPA functionality
  • Checks if teleport destinations are safe to use to prevent suffocation
  • Provides physical Portal areas that, when walked into, teleport the player to the associated position in any dimension or to another Minecraft server altogether
  • Players riding a Horse, Camel, Boat, Minecart, etc. are teleported together with their ride and all other passengers
  • Usable in multiplayer (Server-side) or singleplayer (Client-side)
  • Server-side functionality does NOT require client-side installation, but see section "Languages" below
  • Minimal configuration with predefined values

Mod Version Minecraft Versions Mod Loader Fabric Requires Fabric API Available on Modrinth Modrinth Downloads Modrinth Followers License Last Commit


Public Teleport Bus *

Commands

Command Only OP Description
/helpteleport Shows information about the commands the player can use
Spawn:
/setspawn ✓ Sets the Spawn point at your current position (Unrelated to the Minecraft world spawn)
/spawn Teleports to Spawn (Needs to be set via the /setspawn command)
Warps:
/setwarp <name> ✓ Sets a Warp position at your current position
/delwarp <name> ✓ Deletes a Warp
/warp <name> Teleports to a Warp
/warps Lists all Warps
Homes:
/sethome [<name>] Sets a Home position at your current position (Default: home)
/delhome <name> Deletes a Home
/home [<name>] Teleports to a Home (Default: home)
/homes Lists all your Homes
Back:
/back Teleports to the last location before using a Home, Warp, or dying
RTP:
/rtp Teleports to a random location within a certain radius of the world spawn (In your current dimension)
Portals:
/setportal <name> from ✓ / ✗ Sets the "from" corner of the Portal from the full block that is currently looked at
/setportal <name> to ✓ / ✗ Sets the "to" corner of the Portal from the full block that is currently looked at
/setportal <name> target ✓ / ✗ Sets the "target" position at your current position
/setportal <name> target "<domain/ip>:<port>" ✓ Sets the "target" to another Minecraft server's URL (including the double quotes!)
/delportal <name> ✓ / ✗ Deletes a Portal
/portals ✓ / ✗ Lists all Portals
TPA:
/tpa <player> Requests teleportation to <player>
/tpahere <player> Requests <player> to teleport to you
/tpahereall ✓ Requests ALL players to teleport to you (Use with care on busy servers)
/tpcancel Cancels your teleportation request
/tpaccept [<player>] Accepts request from <player> (Default: Oldest request)
/tpdeny [<player>] Denies request from <player> (Default: Oldest request)

Please note:

  • TPA functionality is disabled in singleplayer
  • /setspawn, /setwarp, /sethome and /setportal <name> target use your current location rounded to a block position and your current viewing angle to create the teleport point
  • /rtp searches in a radius that is configurable with the rtpRadius option (See section "Configuration" below)
  • When /rtp selects a never-visited region, multiple chunks can be created, which can influence server performance (Same as when users fly into new regions)
  • /setportal: See section "Portals" below
  • When teleporting and the target position is not safe to teleport to, a search for a safe position in a 5x5x5 area around the target position is started

Configuration

On first run a config file is created (config/public-teleport/config.json) with these defaults:

Field Default Range Description
defaultLanguage "en_us" See section "Languages" below The default language used
enableSpawn true true or false When true the /setspawn, /spawn commands are enabled
enableWarps true true or false When true the /setwarp, /delwarp, /warp, /warps commands are enabled
enableHomes true true or false When true the /sethome, /delhome, /home, /homes commands are enabled
enableBack true true or false When true the /back command is enabled
enablePortals true true or false When true the /setportal, /delportal, /portals commands are enabled and the Portals are open
enableTpa true true or false When true the /tpa, /tpahere, /tpahereall, /tpcancel, /tpaccept, /tpdeny commands are enabled
enableRtp true true or false When true the /rtp command is enabled
maxHomes 10 Minimum: 0 The maximum number of Homes a player can have (Set to 0 to disable limit)
requestTimeout 60 Minimum: 10 How long a teleport request stays active before it is removed (In seconds)
rtpRadius 5000 Minimum: 200 The maximum radius around the world spawn used by /rtp
portalCommandsOnlyOp true true or false When true only OP can use the Portal commands (Portals themselves are always usable by anyone)

To change these settings edit the config file and restart your server/client.

Portals

Portals are physical areas a user can walk into to be teleported to the associated target position in any dimension or to be redirected to another Minecraft server.
When a Portal is created (Saved) the air blocks in the portal area and the two corner blocks (from and to) are replaced with Purple Stained Glass Panes (Only if the Portal area is smaller than 1000 block³), other blocks are left untouched. The glass panes can be broken and replaced with any block that a user can walk into, e.g. Air, Water, Honey, Powdered Snow, Cobwebs, Fences, Trapdoors, Doors, Buttons, etc.
Portals can have any size; the number of particles emitted from it grows with the Portal volume up to a maximum of 5000 per second, so very large Portals have fewer particles per block.
Using /setportal:

  • The command has three parts (from, to, target); all three parts need to be set with the same name for the Portal to be saved
  • Started Portals that are not saved yet are lost on server restart
  • For normal players to create Portals (Using a Portal is always possible) the option portalCommandsOnlyOp needs to be set to false (See section "Configuration" above)
  • Setting the target to a URL (Redirecting to another Minecraft server) is only allowed for OPs (No matter what portalCommandsOnlyOp is set to), this is a security measure

Languages

Language Value (defaultLanguage config field)
English "en_us"
German "de_de"

If you want to provide more translations, feel free to open an Issue.

Multiplayer usage

Server-side: The Configuration defaultLanguage defines the language all messages are in. (Output on the console is always in English.)

Client-side: If the player has installed this mod on their client, defaultLanguage is overridden with the client's language setting.

Singleplayer usage

The Configuration defaultLanguage has no effect; the client's language setting is used.

Known oddities

Camels with saddles are arriving at the target position sitting down.

Installation

Requires Fabric API to be installed.

  • Download the .jar file from the Releases page that fits your Minecraft version and put it into the mods folder on your server/client
  • (Re)Start your server/client
  • If needed edit the configuration as described in the section "Configuration" above

* Bus model by TheJeroen

About

An easy-to-use Fabric Teleport and Portal Mod: Homes, Warps, Portals, Back, Spawn and TPA; Usable with rides; Server- and/or client-side; Minimal pre-defined configuration!

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages