
Portals
resident-uhlig
Portals
About
This extension lets you create portals between supported tokens in order to teleport character tokens on the map.
You can use the portals as traps, regular portals or teleportation circles.
Features
- Create one-way portals (from origin to destination)
- Create two-way portals (both ends are origin and destination)
- Teleport character token when moving center of character token into bounding box of origin token
Installation
Install Your Extension using the URL https://resident-uhlig.gitlab.io/owlbear-rodeo-portals/manifest.json.
Usage
Permissions
Only players with the role GM
may:
- Create portals
- Delete portals
- Show existing links between origins and destinations
- Disable/enable portals
- Toggle confirmation for teleportation
All players with permission to move a character token may enter a portal.
Scope
All settings are stored as metadata of either tool or token.
Supported tokens
The following type of tokens are supported:
Create portals
There are two ways to add portals on your map.
-
Add a link between two existing tokens.
- Activate the Portals tool.
- Activate the Attach Teleport to Token mode.
- Click on the token that should be the origin.
- Click on the token that should be the destination.
- A notification is shown, that the link has been created.
-
Place two new tokens and automatically link them.
- Activate the Portals tool.
- Click the Set Image (Origin) action to pick a token as the origin. (You only have to do this once.)
- Click the Set Image (Destination) action to pick a token as the destination. (You only have to do this once.)
- Activate the Add Teleport Token to Map mode.
- Click on the map where the origin should be placed.
- Click on the map where the destination should be placed.
- A notification is shown, that the link has been created.
ℹ️ The tokens are added to the "PROPS" layer by default. You can change the layer for them like every normal token.
Enter a portal
- Select a character token.
- Move it to the center of the token into the bounding box of a portal origin.
- The character token is automagically teleported to the portal's destination.
- The viewport of the player (all connections) that moved the token is centered on that token.
Keep relative position
You can configure a destination to keep teleported tokens in the same relative position they had before teleporting. This can be useful if you intend to use the portal for multiple tokens at once, e.g. for actual portals instead of simple traps.
- Right-click on a destination token.
- Click the Spread Arrivals context menu.
- From now on the destination will spread the teleported tokens accordingly.
You can change this setting back by using the Overlap Arrivals context menu.
Create two-way portals
Usually new portals only work in one direction, from origin to destination. To create two-way portals, you can either create a one-way portal and then link the destination back to the origin manually.
Or you can toggle the direction for new portals. If the two-way direction is enabled, new links automatically are created in both directions.
Delete portals
- Right-click on an origin token.
- Click the Remove Destination context menu.
- The link is removed (without notification.)
Show existing links
The links are only shown for yourself and not for any other player or GM.
- Activate the Portals tool.
- Click the Show Links action.
- The existing links are shown.
- Click the Hide Links action.
- The existing links are no longer shown.
Disable/enable portals
You can disable or enable individual portals.
- Right-click on the origin token.
- Click the Disable Teleport context menu.
- The portal is disabled.
You can enable the portal again by using the Enable Teleport context menu.
Toggle confirmation for teleportation
By default, a character token is teleported automatically when dropped on a portal. You can enable a confirmation per portal:
- Right-click on the origin token.
- Click the Confirm Teleport context menu.
- The next time a token is dropped on the portal, the user is asked before the token is teleported.
You can disable the confirmation again by using the Automagic Teleport context menu.
Show/hide context menu
During a game session you might want to remove clutter from the context menu. For this, you can hide the context menu entries of this extension.
- Activate the Portals tool.
- Click the Hide Context Menu Entries action.
- The context menu entries are removed.
- Click the Show Context Menu Entries action.
- The context menu entries are created again.
Troubleshooting
Verify portals integrity
-
Activate the Portals tool.
-
Click the Verify Portals Integrity action.
-
A notification is shown, that indicates the integrity. Also, all offending items are selected.
Furthermore, if there are any errors, you can open the browser's JavaScript console (Ctrl + Shift + J or F12) for details.
Support
If there are any issues with the extension, join the Owlbear Rodeo Discord, create a new post and mention @resident_uhlig
in the #extension-support channel.
For general comments, please use the thread Portals chat.