Details

Last Updated
9 hours ago
First Uploaded
9 hours ago
Downloads
92
Likes
2
Size
185KB
Dependency string
ScarletMods-ScarletTeleports-0.1.37
Dependants

ScarletTeleports

ScarletTeleports adds a complete teleport system to V Rising servers. Players and admins can create, manage, and use personal or global teleport points, request teleports to other players, easily list or remove teleports, and set custom costs, cooldowns, and permissions. The mod also allows defining restricted zones where teleportation is limited, configuring consumable items required for each teleport, and setting individual limits per player. All features are accessible through chat commands, with permission support and advanced options for server administration.

Update

Update 0.1.37

  • Fixed compatibility issue with KindredCommands due to command prefix conflict (st). Scarlet Teleports now uses stp as its new prefix.
  • Added to the command bypass the restricted option to allow teleportation in restricted zones

Features

  • Personal Teleports:
    Players can set, list, use, and remove their own teleport points, with configurable limits and cooldowns.

  • Global Teleports:
    Admins can create teleport points accessible to all players, with full control over location, cost, cooldown, and name.

  • Teleport Requests:
    Players can request to teleport to each other, with accept/deny mechanics for safe and consensual travel. (Teleports between players are considered Global Teleports)

  • Summon & Goto:
    Admins can instantly teleport to players or summon them, individually or all at once.

  • Restricted Zones:
    Define areas where teleportation is limited or blocked, with fine-grained control over entry and exit permissions. (Dracula's room is restricted by default)

  • Custom Prefabs & Costs:
    Assign custom prefabs, costs, and cooldowns to teleports for immersive or balanced gameplay.

  • Bypass & Permissions:
    Grant special permissions to players to bypass certain restrictions, such as teleport in combat, cost, zone limits and other restrictions.

  • Comprehensive Command System:
    All features are accessible via easy-to-use chat commands, with detailed feedback and error messages.

  • Data Persistence:
    All teleports and settings are saved and loaded automatically, ensuring nothing is lost on server restart.


Usage

For a full list of commands and usage, expand the Show Commands.

Show Commands

Admin Commands

Teleportation

  • .stp goto

    • Usage: .stp goto <x> <y> <z> or .stp goto <player-name>
    • Description: Teleport to the specified coordinates or to the specified player.
  • .stp summon

    • Usage: .stp summon all or .stp summon <player-name>
    • Description: Teleport all players to you or teleport a specific player to you.

Global Teleports

  • .stp add global

    • Usage: .stp add global <teleport-name> <x> <y> <z> or .stp add global <teleport-name>
    • Description: Add a global teleport at the specified coordinates or at your current position.
  • .stp make global

    • Usage:
      • .stp make global <teleport-name> <prefab-name> <prefab-guid> <cost> <cooldown> <x> <y> <z>
      • .stp make global <teleport-name> <prefab-name> <prefab-guid> <cost> <cooldown>
    • Description: Create a custom global teleport at the specified coordinates or at your current position.
  • .stp remove global

    • Usage: .stp remove global <teleport-name>
    • Description: Remove a global teleport.

Personal Teleports

  • .stp add personal

    • Usage: .stp add personal <player-name> <teleport-name> <x> <y> <z> or .stp add personal <player-name> <teleport-name>
    • Description: Add a personal teleport for a player at the specified coordinates or at your current position.
  • .stp make personal

    • Usage:
      • .stp make personal <player-name> <teleport-name> <prefab-name> <prefab-guid> <cost> <cooldown> <x> <y> <z>
      • .stp make personal <player-name> <teleport-name> <prefab-name> <prefab-guid> <cost> <cooldown>
    • Description: Create a custom personal teleport for a player at the specified coordinates or at your current position.
  • .stp remove personal

    • Usage: .stp remove personal <player-name> <teleport-name>
    • Description: Remove a player's personal teleport.

Restricted Zones

  • .stp add restricted

    • Usage: .stp add restricted <name> <radius> <x> <y> <z> or .stp add restricted <name> <radius>
    • Description: Add a restricted zone at the specified coordinates or at your current position.
  • .stp make restricted

    • Usage:
      • .stp make restricted <name> <radius> <can-teleport-to> <can-teleport-from> <x> <y> <z>
      • .stp make restricted <name> <radius> <can-teleport-to> <can-teleport-from>
    • Description: Create a custom restricted zone at the specified coordinates or at your current position.
  • .stp remove restricted

    • Usage: .stp remove restricted <name>
    • Description: Remove a restricted zone.

Listing

  • .stp list
    • Usage:
      • .stp list all
      • .stp list restricted
      • .stp list global
      • .stp list <player>
    • Description: List all teleports, restricted zones, global teleports, or a specific player's teleports.

Settings & Management

  • .stp bypass

    • Usage: .stp bypass <player-name> <cost|cooldown|dracularoom|combat|restricted> <true|false>
    • Description: Set bypass options for a player.
  • .stp set default

    • Usage: .stp set default <global|personal> <prefabname|prefabguid|cost|cooldown> <value>
    • Description: Set default values for teleports.
  • .stp set maxteleports

    • Usage: .stp set maxteleports <player-name> <max-teleports>
    • Description: Set the maximum number of personal teleports for a player.
  • .stp set cost

    • Usage:
      • .stp set cost <player-name> <teleport-name> <cost>
      • .stp set cost <global-teleport-name> <cost>
    • Description: Set the cost for a personal or global teleport.
  • .stp set cooldown

    • Usage:
      • .stp set cooldown <player-name> <teleport-name> <cooldown>
      • .stp set cooldown <teleport-name> <cooldown>
    • Description: Set the cooldown for a personal or global teleport.
  • .stp set prefab

    • Usage:
      • .stp set prefab <player-name> <teleport-name> <prefab-name> <prefab-guid>
      • .stp set prefab <teleport-name> <prefab-name> <prefab-guid>
    • Description: Set the prefab for a personal or global teleport.
  • .stp get info

    • Usage:
      • .stp get info <player-name> <teleport-name>
      • .stp get info <teleport-name>
    • Description: Show detailed info for a personal or global teleport.

Utilities

  • .stp whereami

    • Usage: .stp whereami (wai)
    • Description: Show your current position.
  • .stp iwanttoclearallglobalteleports

    • Usage: .stp iwanttoclearallglobalteleports
    • Description: Remove all global teleports.
  • .stp iwanttoclearallplayerteleports

    • Usage: .stp iwanttoclearallplayerteleports
    • Description: Remove all personal teleports.

User Commands

Personal Teleports

  • .stp setteleport | .stp stp

    • Usage: .stp setteleport <name>
    • Description: Create a personal teleport at your current position. You cannot create teleports in restricted zones (unless you are admin or have permission), nor exceed your personal teleport limit.
  • .stp removeteleport | .stp rtp

    • Usage: .stp removeteleport <name>
    • Description: Remove a personal teleport by name.

Teleportation

  • .stp teleport | .stp tp
    • Usage: .stp teleport <name>
    • Description: Teleport to a personal or global teleport by name. Respects combat, Dracula's room, and restricted zone limitations, except for admins or players with bypass permissions.

Listing

  • .stp listteleport | .stp ltp
    • Usage: .stp listteleport
    • Description: List all available personal and global teleports.

Teleport Requests

  • .stp teleportrequest | .stp tpr

    • Usage: .stp teleportrequest <player>
    • Description: Request to teleport to another player. Only one pending request at a time is allowed. Consumes the configured item, except for admins.
  • .stp teleportaccept | .stp tpa

    • Usage: .stp teleportaccept <player>
    • Description: Accept a teleport request from another player. The requester will be teleported to you, as long as both are not in combat, restricted zones, or Dracula's room (except admins or players with bypass).
  • .stp teleportdeny | .stp tpd

    • Usage: .stp teleportdeny <player>
    • Description: Deny a teleport request from another player.

Installation

Requirements

This mod requires the following dependencies to function correctly:

Make sure both are installed and loaded before installing ScarletTeleports.

Manual Installation

  1. Download the latest release of ScarletTeleports.

  2. Extract the contents into your BepInEx/plugins folder:

    <V Rising Server Directory>/BepInEx/plugins/
    

    Your folder should now include:

    BepInEx/plugins/ScarletTeleports.dll
    
  3. Ensure VampireCommandFramework is also installed in the plugins folder.

  4. Start or restart your server.


Configuration

All settings can be adjusted in the ScarletTeleports.cfg file located in your server's BepInEx/config folder.

Show Settings

General

  • EnablePersonalTeleports: If enabled, allows players to create personal teleports.
    Default: true

  • EnablePersonalCooldown: Enables cooldown for personal teleports.
    Default: true

  • EnableGlobalCooldown: Enables cooldown for global teleports.
    Default: true

  • EnableDraculaRoom: Enables teleporting from and to the Dracula's room.
    Default: false

  • EnableTeleportInCombat: Enables teleporting while in combat globally.
    Default: false

  • EnableTeleportBetweenPlayers: Enables teleporting between players.
    Default: true

  • DefaulMaximumPersonalTeleports: The maximum number of personal teleports a player can have.
    Default: 3

Timers

  • TeleportRequestExpiration: The expiration time in seconds of a teleport request.
    Default: 30

  • DefaultPersonalCooldown: The cooldown in seconds for personal teleports.
    Default: 30

  • DefaultGlobalCooldown: The cooldown in seconds for global teleports.
    Default: 30

Prefabs

  • DefaultPersonalPrefabName: The name of the prefab that will be consumed when teleporting to a personal teleport.
    Default: Blood Essence

  • DefaultPersonalPrefabGUID: The GUID of the prefab that will be consumed when teleporting to a personal teleport.
    Default: 862477668

  • DefaultGlobalPrefabName: The name of the prefab that will be consumed when teleporting to a global teleport.
    Default: Blood Essence

  • DefaultGlobalPrefabGUID: The GUID of the prefab that will be consumed when teleporting to a global teleport.
    Default: 862477668

Costs

  • DefaultPersonalCost: The amount of the prefab that will be consumed when teleporting to a personal teleport.
    Default: 100

  • DefaultGlobalCost: The amount of the prefab that will be consumed when teleporting to a global teleport.
    Default: 50


Support

For help, bug reports, or suggestions, please join the Scarlet Mods Discord.

Thunderstore development is made possible with ads. Please consider making an exception to your adblock.
Thunderstore development is made possible with ads. Please consider making an exception to your adblock.
Thunderstore development is made possible with ads. Please consider making an exception to your adblock.