Integrations

Last updated Sep 18, 2026

Integrations

SoapsTeleporter optional hooks. All region integrations are off by default in config.yml.

Soft dependencies from plugin.yml: PlaceholderAPI, Vault, WorldGuard, Lands.

Hard dependency: SoapsCommon.


PlaceholderAPI

Registers automatically when PlaceholderAPI is installed. Identifier: soapsteleporter.

No extra configuration. See Placeholders for the full token list.


Vault (Economy)

Required for money costs and money conditions.

Setup

  1. Install Vault
  2. Install a Vault economy provider (EssentialsX, CMI, etc.)
  3. Set in config.yml:
economy:
  enabled: true
  currency-format: "$%.2f"
  payment-timing: "before"
  refund-on-failure: true

Enables

  • /st setcost <portal> <amount> for money
  • Money balance conditions via GUI / /st manage (check only, no charge)
  • Placeholders %soapsteleporter_economy_balance% and %soapsteleporter_economy_spent%

Details: Economy (payment timing, refunds, and post-charge rollback).


WorldGuard

Respect protected regions when creating and using portals.

integrations:
  worldguard:
    enabled: false
    require-build-permission: true
    check-teleport-permission: true
    respect-claims-rtp: true
Option Description
require-build-permission Need build rights to create portals in a region
check-teleport-permission Block teleport if the player cannot teleport in that region
respect-claims-rtp RTP avoids protected regions

Players see integrations.worldguard-denied from messages.yml when blocked.


Lands

Respect land claims for portal creation and RTP.

integrations:
  lands:
    enabled: false
    respect-claims-rtp: true
    require-land-permission: true
Option Description
respect-claims-rtp RTP avoids claimed land
require-land-permission Need land permission to create portals in claims

Players see integrations.lands-denied when blocked.


SoapsCommon

SoapsTeleporter depends on SoapsCommon for shared formatting, GUI infrastructure, and startup checks. Install the matching SoapsCommon version before enabling SoapsTeleporter.

If the server uses a standalone SoapsCommon JAR, place it in plugins/ alongside SoapsTeleporter.


Requirements

Plugin Purpose
SoapsCommon Shared library

Optional

Plugin Purpose
PlaceholderAPI Custom placeholders
Vault + economy Money costs
WorldGuard Region checks
Lands Claim checks

Next Steps