TeleportRay
Adds a visual teleport ray for selecting teleport destinations and a Marker Teleport function for saving and returning to a temporary position.TeleportRay
This mod adds a visual teleport ray and Marker Teleport system that allows the local player to select teleport destinations, save a temporary position, and return to it using configurable keys.
Features
The mod includes Curve Teleport, Straight Teleport, and two independent Marker Teleport destinations. Each feature can be activated using configurable key bindings.
TeleportRay input is intentionally blocked while the terminal or chat is being used.
Teleport destinations and Marker Teleport positions are automatically reset when relevant game or world states change.
Curve Teleport
Curve Teleport allows the local player to select a destination using a curved visual ray.
To use Curve Teleport:
-
Press T to activate Curve Teleport.
-
A curved ray appears from the player's view toward the detected destination, and a circular marker indicates the selected teleport destination.
-
Press T again to teleport to the selected position.
Curve Teleport determines its destination using the environment detected in front of the player.
If no valid destination can be detected, teleportation is not performed.
The ray and destination marker use the color configured through the Ray Color setting.
Straight Teleport
Straight Teleport allows the local player to teleport directly toward the viewing direction using a straight visual ray.
To use Straight Teleport:
- Press Y to activate Straight Teleport.
- A straight ray appears in the player's viewing direction, and a circular marker indicates the selected teleport destination.
- Press Y again to teleport to the selected position.
If the ray detects a collider within the configured distance, the teleport destination is placed at the detected position.
If no collider is detected, the destination is placed in mid-air at the maximum configured distance.
Straight Teleport supports teleportation to airborne destinations without requiring a surface beneath the target.
The maximum teleport distance can be adjusted through the Straight Teleport Distance setting.
The distance setting applies only to Straight Teleport and does not affect Curve Teleport or Marker Teleport.
Marker Teleport
The Marker Teleport Key allows the local player to temporarily save their current position and return to it later.
Each marker can store a separate destination.
To use Marker Teleport:
- Move to the position you want to save.
- Press X to save Marker Teleport A, or C to save Marker Teleport B.
- A circular marker appears at the saved position, and the marker is labeled A or B to identify its destination.
- Press the corresponding key again to teleport back to the saved position.
After requesting teleportation to a saved position, the corresponding marker is automatically cleared.
Marker Teleport A and Marker Teleport B operate independently. Clearing one marker does not remove the other.
Saved positions are temporary and are not written to the configuration file.
Host Permission System
TeleportRay includes a host-controlled permission system for multiplayer sessions.
The host can determine whether connected clients are allowed to use TeleportRay through the Allow Clients setting.
When enabled, clients with TeleportRay installed can request permission to use its teleportation functions.
When disabled, clients cannot use TeleportRay, while the host can continue using the mod.
Client teleportation requests are sent to the host for validation before being executed locally.
The permission system applies to Curve Teleport, Straight Teleport, and Marker Teleport A/B.
The host and client must use compatible versions of TeleportRay for the communication system to function correctly.
Marker Teleport UI
A small Marker Teleport status display is shown on the HUD.
The UI displays the current status of Marker Teleport A and Marker Teleport B.
Possible display states include:
| Display | Description |
|---|---|
| MARKER: -- / -- | Neither marker is saved. |
| MARKER: A / -- | Only Marker Teleport A is saved. |
| MARKER: -- / B | Only Marker Teleport B is saved. |
| MARKER: A / B | Both markers are saved. |
The Marker Teleport UI uses the same color configured for the teleportation rays and markers.
The UI can be enabled or disabled independently through the configuration.
- Dashboard Position
If you want to adjust the position of the Marker Teleport UI during gameplay, you can optionally use CursorToggle by azumi. CursorToggle allows the mouse cursor to be enabled during gameplay, making it possible to reposition the Marker Teleport UI directly by dragging it to the desired location. This provides a more convenient method of adjusting the UI position without having to repeatedly modify the Position X and Position Y values in the configuration.
Its position can also be adjusted through the Position X and Position Y configuration settings.
The position coordinates are relative to the center of the screen.
Manual Reset
Manual Reset
The Reset Marker Teleport Key allows the player to manually reset active teleportation functions.
Pressing F5 performs the following actions:
-
Cancels an active Curve Teleport or Straight Teleport ray.
-
Clears Marker Teleport A if a destination is saved.
-
Clears Marker Teleport B if a destination is saved.
-
Resets both teleportation rays and saved markers when applicable.
A notification is displayed to indicate which functions were reset.
Automatic Reset
TeleportRay automatically clears temporary teleport information when it is no longer appropriate to retain it.
This includes relevant changes such as:
- Landing or taking off.
- Changing moons or levels.
- Returning to orbit.
- Ending or leaving the current game.
- Relevant scene changes.
- The local player becoming unavailable or dying.
This prevents a previously saved world-space position from being reused after the game environment has changed.
Config
You can change the settings in the config file. Edit the config if desired. We recommend editing the file using LethalConfig by AinaVT.
If old configuration source files remain, the configuration settings may not be applied correctly. In that case, please follow the steps below.
-
Access the profile in the Thunder Store's local files.
Thunderstore Mod Manager/DataFolder/LethalCompany/profiles/(Optional profiles) -
Delete the TeleportRay configuration source file from the BepInEx directory.
BepInEx/config/azumi.teleportray.cfg -
In the Thunder Store, click Modded on the relevant profile to launch the game. This will automatically generate a new configuration file.
General
You can optionally configure the following items in the config.
| Setting | Default | Consideration |
|---|---|---|
| TeleportRay Enabled | True | Enables or disables the TeleportRay system. |
| Allow Clients | True | This feature is available only to the host. |
| Marker Teleport UI Enabled | True | -- |
| Ray Color | #00F0FF | Slight color differences may occur due to rendering and transparency. |
| Straight Teleport Distance | 100 | Min: 1 / Max: 100 |
Controls
You can optionally set the assignments for the following keys in the config.
| Setting | Default |
|---|---|
| Curve Teleport Key | T |
| Straight Teleport Key | Y |
| Marker Teleport A Key | X |
| Marker Teleport B Key | C |
| Reset Marker Teleport Key | F5 |
Position
You can configure the Marker Teleport UI position using the following settings.
| Setting | Default | Consideration |
|---|---|---|
| Position X | 340 | Min: -366.0 / Max: 373.0 |
| Position Y | 200 | Min: -258.0 / Max: 237.0 |
The position coordinates are relative to the center of the screen.
The configurable range is intended to keep the Marker Teleport status text within the usable screen area.
Installation
In addition to installing and managing mods through the Thunder Store, if you wish to install this mod directly via the mod manager linked to the Thunder Store, please follow the steps below.
-
Access the profile in the Thunder Store's local files.
Thunderstore Mod Manager/DataFolder/LethalCompany/profiles/(Optional profiles) -
Place TeleportRay.dll in the BepInEx directory.
BepInEx/plugins/azumi-TeleportRay/TeleportRay.dll -
In the Thunder Store, click Modded on the relevant profile to launch the game.
Version
The mod has been tested and confirmed to work on the following versions:
v81
Notes
-
This mod is operates on the local player. Multiplayer client usage requires permission from the host.
-
Curve Teleport attempts to determine an appropriate destination using the environment detected in front of the local player. A valid or safe destination is not guaranteed under every possible map, collider, or modded environment configuration.
-
Straight Teleport can select destinations in mid-air when no collider is detected within the configured range. Airborne destinations may result in falling or other unintended movement behavior.
-
Marker Teleport A and Marker Teleport B store independent temporary positions. These positions are not persistent across relevant game or world transitions.
-
Although TeleportRay attempts to restore relevant local player environment states when using Marker Teleport, unusual transitions or heavily modified environments may still result in unexpected behavior.
-
Teleportation may allow movement that is not normally possible through vanilla player movement. As a result, using this mod may affect gameplay balance compared with the vanilla experience.
-
The mod relies on the games internal systems, including those for the player, HUD, scene, physics, and teleportation systems. Future game updates may change these systems and require an update to the mod.
-
Compatibility may be affected by other mods that significantly modify player teleportation, player state handling, HUD elements, physics layers, Facility transitions, or related systems.
