Getting Started

Last updated Oct 28, 2026

Getting Started

Install SoapsTeleporter 1.0.7 and confirm a linked portal pair works.

Requirements

Requirement Details
Plugins SoapsCommon
Server Paper 26.1, 26.2, and 26.3
Spigot / Folia Not supported
Java 21+ (Java 25 recommended)

Optional

Integration Purpose
Vault + economy Money costs
PlaceholderAPI Placeholders
WorldGuard Region checks
Lands Claim checks

Downloads are ZIPs. Extract the .jar into plugins/.

Installation

  1. Download SoapsCommon and SoapsTeleporter; extract both jars.
  2. Put jars in plugins/ and fully restart (not /reload).
  3. Confirm green plugins and console shows SoapsTeleporter 1.0.7.
Symptom Fix
Red plugin, no data folder JAR still inside a ZIP, or SoapsCommon missing
SoapsCommon green, ST red Check logs/latest.log — see Troubleshooting

First-run files

plugins/SoapsTeleporter/
  config.yml
  messages.yml
  gui.yml
  portals.yml

Full defaults: Config Reference

First portal pair

  1. /st wand — left-click pos1, right-click pos2.
  2. /st add spawn
  3. Select corners at the destination → /st add market
  4. /st connect spawn market
  5. Walk into either portal.

More detail: Want link two portals · Portal Creation

Admin path

  1. /st manage — Visual, Audio, Economy, Connection, Conditions, Commands, Admin
  2. YAML — config.yml globals, messages.yml / gui.yml text
  3. /st set* — power-user tweaks

Prefer GUI day-to-day; YAML for server-wide defaults and copy.

Reload policy

Change What to run
Most manage / set* edits Apply at runtime (saved to portals.yml)
YAML file edits (config.yml, messages.yml, gui.yml) /st reload
Jar upgrade / first install Full server restart (not /reload)

/st reload also runs a self-test (config, messages, portals, particles, permissions, files).

Verify

/st list
/st info spawn
/st manage
  1. Plugin enables with version 1.0.7.
  2. /st list shows your portals.
  3. Walk into a linked portal → arrive at the other side with sound/particles.
  4. Optional: set a cost or condition and confirm it blocks/charges correctly.
  5. Empty portals.yml (portals: {}) is fine until you create portals.

Common goals

Goal Page
Link two locations Want link two portals
RTP portal Want RTP portal
Paid gate Want paid gate
Restrict access Want restrict portal
One-way Want one-way portal

Next: Configuration · Upgrading to 1.0.7 · FAQ

Still stuck? Ask about this page