SoapsUniverse
SoapsTeleporter
SoapsTeleporter

Getting Started

HomeIntroductionGetting Started

Configuration

ConfigurationDefault Config Files

Guides

Portal CreationPortal TypesParticles and EffectsConditionsEconomyInteractive Management

Reference

Commands and PermissionsIntegrationsPlaceholdersExamples

Support

FAQChangelog

Getting Started

Last updated Jul 6, 2026

Getting Started

This page walks you through installing SoapsTeleporter and creating your first linked portal pair.

Requirements

Requirement Details
Server Paper 1.21+
Java 21 or newer
Required plugin SoapsCommon (same suite version)
Optional Vault + economy plugin for money costs
Optional PlaceholderAPI for scoreboard placeholders

Installation

  1. Install SoapsCommon if your server uses the standalone library JAR.
  2. Download SoapsTeleporter.jar and place it in plugins/.
  3. Start or restart the server.
  4. Confirm the plugin enables. Config files are created in plugins/SoapsTeleporter/.

Expected console output includes the plugin name and version 1.0.5.

Your First Portal Pair

Step 1: Get the wand

/st wand

You receive the Portal Wand. Permission: st.command.wand (legacy alias: st.command.tool).

Step 2: Select two corners

With the wand in hand:

  • Left-click a block to set position 1
  • Right-click a block to set position 2

Both positions must be in the same world. You can also set positions with /st set p1 and /st set p2 while standing at each corner.

Step 3: Create the first portal

/st add spawn

Replace spawn with your portal name. Names are case-insensitive.

Step 4: Create the second portal

Move to the destination area, select two new corners, then:

/st add market

Step 5: Connect them

/st connect spawn market

Walking into either portal teleports the player to the other (standard two-way link).

Verify It Works

Walk into a portal. You should see particles, hear the teleport sound, and arrive at the linked portal.

If something fails:

/st info spawn
/st list
/st debug issues
/st debug overlay

Reload runs a self-test automatically:

/st reload

Portal Orientation

The plugin detects orientation from your selection:

  • Vertical portals stand like doorways. Players walk through them.
  • Horizontal portals lie flat like floor pads. Players step on them.

Flat selections (about 1 block tall with larger width or length) are treated as horizontal.

Essential Commands

Command Purpose
/st wand Get the selection wand
/st add <name> Create a portal from the current selection
/st connect <a> <b> Link two portals
/st list List all portals
/st info <name> View portal details
/st manage <name> Open the management interface
/st remove <name> Delete a portal
/st help Command help with pagination
/st help <command> Detailed help for one subcommand

Next Steps

Discord