Default config.yml

Shipped defaults from SoapsTeleporter 1.0.7. After first run, this file lives in plugins/SoapsTeleporter/.

Updating the jar does not overwrite your live copy. Use this page to compare or reset.

See also: Config Reference · Configuration

# ############################################
# #                                          #
# #   Plugin: SoapsTeleporter                #
# #                                          #
# #   Created by AlternativeSoap             #
# #   Website: www.SoapsUniverse.com         #
# #   Support: https://discord.gg/mawAzwFq   #
# #                                          #
# ############################################

# ==========================================
# General Settings
# ==========================================
general:
  # Enable debug logging (can also be toggled with /st debug)
  debug: false
  # Auto-save interval in minutes (0 to disable, recommended: 5-15)
  auto-save-interval: 5
  # Message spam prevention cooldown (milliseconds)
  message-cooldown: 3000

# ==========================================
# GUI Settings
# ==========================================
gui:
  # Enable GUI-based portal management (opens chest inventories)
  # When enabled: all management uses GUI menus, interactive chat is disabled
  # When disabled: all management uses the interactive chat system (clickable text)
  enabled: true

# ==========================================
# Performance Settings
# ==========================================
performance:
  # Maximum particles to spawn per tick (0 = unlimited, recommended: 100-200 for busy servers)
  max-particles-per-tick: 200
  # Maximum particles per portal (0 = unlimited)
  max-particles-per-portal: 500
  # Radius for detecting nearby players for particle rendering (blocks)
  nearby-player-radius: 30.0
  # Enable adaptive particle density based on player count
  adaptive-density: true
  # Number of online players required to trigger density limiting
  adaptive-density-player-threshold: 15
  # Multiply particle counts by this factor when adaptive density is active
  adaptive-density-reduction-factor: 0.5
  # Adaptive quality tick interval (ticks)
  adaptive-tick-interval: 4

# ==========================================
# Particle Settings
# ==========================================
particles:
  # Enable particle effects globally
  enabled: true

  # Portal Region Particles
  portal:
    # Particle type (supports ALL Minecraft particles)
    # Popular: DUST, FLAME, END_ROD, PORTAL, ENCHANT, HEART, HAPPY_VILLAGER
    particle: "DUST"
    # Fallback count when auto-fit cannot run (new portals auto-fit to 2x air blocks, min 8)
    count: 24
    # Particle spread/distribution (0.0 = tight, 1.0 = wide)
    spread: 0.45
    # Display interval in ticks (8 = 0.4 seconds)
    interval: 8
    # Default DUST color for new portals (hex). Visible violet — not black.
    default-color: "#7C4DFF"
    # Enable 3D volumetric particles (fills entire portal space)
    volumetric-rendering: true

  # Teleportation Effect Particles
  teleport:
    particle: "ENCHANT"
    count: 30

  # Portal Selection Markers (wand p1/p2)
  selection:
    particle: "END_ROD"
    count: 1
    # Display interval in ticks (20 = 1 second)
    interval: 20
    spread: 0.2

# ==========================================
# Portal Mechanics
# ==========================================
portals:
  limits:
    # Maximum portals per player (0 = unlimited, bypass: st.portal.limit.bypass)
    max-portals-per-player: 0
    # Maximum portals per world (0 = unlimited)
    max-portals-per-world: 0
    # Maximum portals per chunk (0 = unlimited, prevents chunk overloading)
    max-portals-per-chunk: 4
    # Portal size limits (blocks of span along the longest axis)
    # min-size 3 = corners must be at least 3 blocks apart on one axis (blocks tiny peepholes)
    max-size: 50
    min-size: 3

  shape-preview:
    # Default frame block used by /st shapepreview place when no material is provided.
    default-frame-material: OBSIDIAN

  teleportation:
    # Preserve relative approach angle when exiting (DEFAULT direction).
    # true  = exit looking out of dest portal with the same offset you entered with
    # false = always face straight out of the destination portal opening
    preserve-orientation: true
    # Auto-adjust landing if destination is blocked
    auto-adjust-destination: true

# ==========================================
# Player Settings
# ==========================================
players:
  permissions:
    # Require specific permissions for portal access
    per-portal-permissions: true
    # Permission node template (%portal% replaced with portal name)
    permission-format: "st.portal.%portal%.use"

# ==========================================
# Safety Settings
# ==========================================
safety:
  # Check for safe teleport destinations
  safe-teleport: true
  # Allow teleportation to different worlds
  cross-world: true
  # Enhanced destination safety checks
  enhanced-safety: true
  # Maximum radius to search for safe landing spots (blocks)
  safe-search-radius: 10

# ==========================================
# Random Teleport (RTP) Settings
# ==========================================
rtp:
  preload:
    enabled: true
    # Chunks to preload around destination (1 = 9 chunks total)
    radius: 1
    # Max wait time for chunk loading (milliseconds)
    timeout: 5000
    # Allow generation of new chunks
    allow-new-chunk-generation: true
    # If true, teleport even when chunk preload fails (unsafe)
    force-unsafe-teleport: false

  # Location search when finding a safe RTP landing spot
  retry:
    # How many random locations to try before giving up
    max-attempts: 50
    # Reserved for future paced retries (milliseconds between attempts)
    retry-delay: 0

# ==========================================
# Portal Protection
# ==========================================
protection:
  enabled: true
  # Radius around portal to protect (blocks)
  radius: 2
  # Protect the portal frame blocks
  protect-frame: true
  # Permission to bypass: st.protection.bypass
  bypass-permission: "st.protection.bypass"

# ==========================================
# Economy Settings (Vault Integration)
# ==========================================
economy:
  # Enable Vault economy integration (requires Vault + economy plugin)
  enabled: true
  # Currency format for display
  currency-format: "$%.2f"
  # Take payment before or after teleportation
  payment-timing: "before"
  # Refund on failed teleportation
  refund-on-failure: true

# ==========================================
# Plugin Integrations (all disabled by default)
# ==========================================
integrations:
  # WorldGuard integration - Respect region permissions
  worldguard:
    enabled: false
    require-build-permission: true
    check-teleport-permission: true
    respect-claims-rtp: true

  # Lands integration - Respect land claims
  lands:
    enabled: false
    respect-claims-rtp: true
    require-land-permission: true