Configuration

Configuration

The config.yml file is the heart of PixelRTPPool. It has been designed without any hardcoded messages, allowing you complete freedom to localize and theme the plugin.

Overview of Sections

1. Teleport Mode

Determines how the teleport command is executed when the countdown finishes.

teleport:
  # Available options: PLAYER, CONSOLE
  mode: PLAYER
  # The command to execute (without the leading slash)
  command: "rtp"

For deep-dives into execution, see Teleport Modes.

2. Regions (The RTP Pools)

Define the WorldGuard region IDs that act as pools.

regions:
  # 'spawn_rtp' MUST precisely match the ID of your WorldGuard region
  spawn_rtp:
    # Time (in seconds) the player must remain in the region before teleporting
    countdown: 3
    # Time (in seconds) before they can use ANY pool again
    cooldown: 30
  vip_rtp:
    countdown: 1
    cooldown: 15

3. Particles

Visual indicators spawned around the player while they wait.

particles:
  enabled: true
  # Standard Bukkit Particle enum
  type: "PORTAL"
  count: 20
  offset:
    x: 0.5
    y: 1.0
    z: 0.5

4. Sounds

Auditory feedback for the countdown sequence.

sounds:
  enabled: true
  # Standard Bukkit Sound enum
  tick_type: "BLOCK_NOTE_BLOCK_PLING"
  teleport_type: "ENTITY_ENDERMAN_TELEPORT"
  volume: 1.0
  pitch: 1.0

5. Titles

Large on-screen text during the countdown.

title:
  enabled: true
  fade_in: 10
  stay: 20
  fade_out: 10

6. Messages

All text output utilizes the Adventure MiniMessage API, meaning you can use robust gradients, hex colors, and interactive text.

messages:
  prefix: "<gray>[<gradient:#00E5FF:#7C4DFF>PixelRTPPool</gradient><gray>]"
  countdown: "<green>Teleporting in <time> seconds... Stay still!"
  teleporting: "<aqua>Whoosh! You have been teleported."
  cancelled: "<red>Teleportation cancelled. You left the pool!"
  cooldown: "<red>You must wait <time> seconds before RTPing again."
  reload: "<green>Configuration successfully reloaded!"

7. World Whitelist (Future)

This is an upcoming feature intended to restrict which dimensions pools can function in. Stay tuned in the Roadmap!

---

🏡 Home | 📖 Read Next: RTP Pools