Register

Quick Teleporters

An Add-on Module for Foundry Virtual Tabletop

Author: WayfinderModules Project: Source Foundry Versions 14+ (Verified 14.368) Last Updated 2 days, 16 hours ago

Quick Teleporters

An automated Teleporter/Change Level region creation tool, linking regions without requiring you to manually connect them, or copy their UUIDs between region sheets. Turn on QTR in the Region controls, draw a region, and select your teleporter type between five currently available (Stairs, Level Up/Down, In-Scene, External, Teleporter Network). If you selected Stairs or Level Up/Down, you're done. If you selected In-Scene/External teleporter, draw another one either on the same scene, or another one entirely. If you selected Teleporter Network, draw as many regions as you want and connect all of them between each other, or just create an elevator. All regions will be connected automatically, assigned generated names with a clean convention so a region list stays readable.

quick-teleporters · v1.1.2 · Foundry VTT v14+ (verified 14.368) · Free · System-agnostic

Requires: Wayfinder Core 1.1.0+.


Installation

Classic manifest install:

  1. In Foundry, open Add-on Modules → Install Module.
  2. Paste this into the Manifest URL field: https://wayfindermodules.com/releases/quick-teleporters/manifest
  3. Click Install.

Install Wayfinder Core the same way first. Every module is listed at wayfindermodules.com.


The QTR Toggle

A QTR(Quick Teleporter Region) toggle is added to the Region Controls. While enabled, every region created opens a dialog window to quickly create a teleporter with a selection of teleporter types.

Create Teleporter confirms your settings and creates a teleporter, or its first step in case of in-scene/external teleporters. Normal Region creates the region exactly as Foundry would, with no teleporter attached. Closing the window cancels the region entirely.


Teleporter Types

Type Description
Stairs Default Foundry Change Level setup: one region appearing on both levels, with a movement confirmation prompt and movement type selection.
Level Up/Down A destination on the level above or below, at the exact same grid coordinates. Provides a Direction dropdown to pick Up or Down.
In-Scene A region created where you draw, then another region drawn somewhere else on the same scene, linking the two.
External The same, except the second region is created on another scene.
Teleporter Network (1.1.0+) Create a series of linked teleporters as either custom placed regions anywhere, or an elevator that moves up and down levels on the current map.

Stairs and Level Up/Down need a scene with levels; they are created on the level you are currently viewing and the one directly above/below it.

For In-Scene and External teleporters, a bar appears above the hotbar once the first end is created. Cancel abandons the process and leaves the first region as an empty region.

A Teleporter Network uses the same bar. Press Finish once all your destinations are placed and the network editor opens.

Elevator-like? appears on scenes with two or more levels and replaces the drawing with a list. Draw once, and an Elevator Stops window will open allowing you to select which levels the 'elevator' goes to and what the player-facing name should be. Every stop is created at the grid position of the region you drew.


Two-Way

Toggling Two-Way in the dialog makes either end connect to the other, so the teleporters function both ways. Toggle it off for a one-way teleporter.

Stairs are always two-way as per Foundry's Change Level region configuration.

For a Teleporter Network this toggle changes the teleporter network from all-ways to single entrance (your original drawn region) with many destinations while Two-Way is off. Otherwise every teleporter is both ways.


Custom Name

Generated region names are convenient and let you know which teleporters lead where and how they are connected, but they are not exactly descriptive to a player. Toggle on Custom Name? in the dialog and a Teleporter Names window opens once the teleporters are created, allowing you to set up a custom player-facing name independent of the region name.

Enabling it also turns Confirm Teleport? and Name Destination? on so the players can actually see the proper name.

Available for Level Up/Down, In-Scene and External. A Teleporter Network can edit its destination names in the network editor. Stairs uses your level name through Foundry's own prompt.


Automatic Names

Regions are named automatically, so a region list tells you what each entry is and which entries are linked together:

Type Names
Stairs Stairs A1
Level Up/Down Teleport Up A1 and Teleport Down A1
In-Scene Teleporter - In Scene A1a and Teleporter - In Scene A1b
External Teleporter - External A1a → Absalom and Teleporter - External A1b → WorldMap
Network Teleporter - Network A1a, Teleporter - Network A1b, and so on

Each type counts separately, and in-scene/external teleporters are additionally marked with a lowercase a or b to differentiate them. A network's stops carry one letter each, from a onwards.


Additional Settings

The dialog's Additional settings section displays options for the teleporter you are drawing. Changing anything here also updates your defaults, except for values the type decides for you. A Teleporter Network always turns Confirm Teleport? and Name Destination? on to remain usable, and Two-Way functions differently there, see above. Custom Name? also enables Confirm Teleport? and Name Destination? What would be the point, otherwise?

Option Effect
Placement Where to teleport the token to inside the destination region
Snap to Grid Snap the token to the grid once its teleported
Confirm Teleport? Show a teleport confirmation prompt to the player who moved the token. If off, token will teleport instantly upon entering the region.
Name Destination? Reveal the destination's name or keep it hidden
Transition The transition animation that is played when a token teleports to another scene
Duration How long the transition lasts

Teleporter Defaults

A Teleporter Defaults window in the Wayfinder Control Panel also allows you to configure the options mentioned above outside of the QTR Create Teleporter interface.


Teleporters

A Teleporters window in the Wayfinder Control Panel lists every teleporter on the current scene and what it is connected to, if anything.

Status Description
Two-way Linked in both directions
One-way Teleports tokens one way
Stairs A default Foundry Change Level set-up
One-Level Stairs Incorrectly configured stairs spanning only one level.
Broken Destination is unreachable. The destination region might have been removed
Unfinished The first of two connected teleporters, with the other yet to be placed
Network A stop of a teleporter network, with every destination reachable
Network, dead link Some of that stop's destinations can no longer be reached
Network, destinations disconnected Stops that no longer link back. Open Edit Network and press Apply to re-connect them
Destination An arrival point: a stop of a one-entrance network, or the other end of a one-way teleporter

The Network Editor

Pressing Finish on a new network opens the editor. It can otherwise be reached through Teleporters list in QT Settings (found in Wayfinder Control Panel). Every teleporter network will show a button in that list to edit the network.

Control Effect
Visible Label What players see for that stop. Left blank, it falls back to the level name
Order Move a stop up or down. Player-facing window sorts them based on the order here
Connections All Stops Connected or One Entrance
Draw More Closes the editor so you can draw more destinations and connect them to the network. Press Finish again to return
Eye icon Selects that region and pans to it. For a stop on another scene it names the scene instead
X icon Takes that region out of the network and leaves it an ordinary region
Apply Writes the changes. Nothing is saved until you press it

A network needs at least two stops. Apply is disabled if you have less than two.


Settings

Setting Default Effect
Deleting a Teleporter Ask Ask, Delete, or Unlink.

Deleting a Teleporter

Whenever you delete a teleporter, the other linked region will become non-functional, as per normal Foundry behavior. In that case you will be offered three choices: Unlink strips the connection between the teleporters and leaves an ordinary region, Delete removes the other region, and Leave closes the window and does nothing to the region. Closing the window is the same as selecting Leave.

Deleting a stop of a Teleporter Network functions similarly. Re-link removes only the stop you deleted and rewires the rest, Delete Network removes all of them, and Leave does nothing.


Support

Questions, bug reports, and feature requests are welcome on the Wayfinder Society Discord.

Changelog · License. Free to use, not open source.

 

Categories

Available Versions

  1. Version 1.1.2

    2 days, 16 hours ago
    Foundry Version 14+ (Verified 14.368) Manifest URL
  2. Version 1.1.1

    1 week, 5 days ago
    Foundry Version 14+ (Verified 14.368) Manifest URL
  3. Version 1.1.0

    2 weeks, 3 days ago
    Foundry Version 14+ (Verified 14.368) Manifest URL
  4. Version 1.0.1

    2 weeks, 5 days ago
    Foundry Version 14+ (Verified 14.368) Manifest URL
  5. Version 1.0.0

    1 month ago
    Foundry Version 14+ (Verified 14.367) Manifest URL