SoapsUniverse
SoapsTeleporter
SoapsTeleporter

Getting Started

HomeIntroductionGetting Started

Configuration

ConfigurationDefault Config Files

Guides

Portal CreationPortal TypesParticles and EffectsConditionsEconomyInteractive Management

Reference

Commands and PermissionsIntegrationsPlaceholdersExamples

Support

FAQChangelog

Introduction

Last updated Jul 6, 2026

Introduction

What is SoapsTeleporter?

SoapsTeleporter lets you place portals anywhere in your world. Players walk into a portal region and teleport to another location, another portal, or a random spot. Each portal can have its own particles, sounds, costs, conditions, and commands.

The plugin targets Paper 1.21+ on Java 21. It requires SoapsCommon as a hard dependency.

Features at a Glance

Portal system

  • Create portals of any rectangular size with the selection wand
  • Connect two portals for two-way travel
  • One-way portals that block return travel from the destination side
  • Random Teleport (RTP) portals with configurable world and range
  • Custom shape portals by selecting individual blocks (shift+right-click on the wand)
  • Shape preview tools to plan portal frames before placing blocks
  • Multi-destination routing: fixed, random, weighted, and permission-based
  • Automatic orientation detection (vertical doorway vs horizontal floor pad)

Visual and audio

  • Per-portal particle type, count, spread, interval, and DUST color
  • 3D volumetric particle rendering
  • Adaptive particle density for busy servers
  • Per-portal teleport sounds with volume and pitch
  • Layered render pipeline with visibility culling (since 1.0.1)

Conditions and access

  • Time, weather, level, sneak, fly, world, biome, and gamemode checks
  • Item, money, advancement, and playtime requirements
  • Health, hunger, armor, weapon, and nearby-player rules (via management UI)
  • Optional condition expressions with AND, OR, and NOT logic (since 1.0.1)
  • Per-portal permissions when enabled in config

Economy

  • Charge money through Vault
  • Charge items, experience, or custom hand-held items
  • Refund on failed teleportation (configurable)

Safety and protection

  • Safe destination checks with configurable search radius
  • Cross-world teleport support
  • Warmup timers that cancel if the player moves
  • Cooldown timers between uses
  • Portal region protection against block break and place

Management

  • Chest GUI management when gui.enabled is true (default)
  • Clickable chat management when GUI is disabled
  • Full tab completion on commands
  • /st help with pagination and per-command detail mode (1.0.5)
  • Backup, reload, and debug diagnostics
  • Auto-save with configurable interval

Integrations

  • PlaceholderAPI placeholders under %soapsteleporter_*%
  • Vault economy
  • WorldGuard region checks (optional)
  • Lands claim checks (optional)

How It Works

  1. Run /st wand and select two corners (or build a custom block selection).
  2. Run /st add myportal to create the portal.
  3. Create a second portal and run /st connect portal1 portal2.
  4. Players enter the portal region to teleport.

From there you can add particles, costs, conditions, routing, and commands per portal.

Next Steps

Discord