Skip to main content

Configuration

The configuration file for Nexal RTP. Located at plugins/Nexal RTP/config.yml.

config.yml
# ══════════════════════════════════════════════════════════
#                     NEXAL RTP CONFIG
# ══════════════════════════════════════════════════════════

# What /rtp with no arguments does: "gui" or "teleport"
default-behavior: gui

# Which place to use when default-behavior is "teleport"
default-place: wilderness

# ──────────────────────────────────────────────────────────
#                       WARMUP
# ──────────────────────────────────────────────────────────

warmup:
  # Seconds to wait before teleporting (0 to disable)
  seconds: 3

  # Cancel the warmup if the player moves
  cancel-on-move: true

  # Show action bar countdown during warmup
  action-bar: true

  # Particles to spawn during warmup (PORTAL, END_ROD, FLAME, etc.)
  particle: PORTAL

# ──────────────────────────────────────────────────────────
#                    SAFE LOCATION
# ──────────────────────────────────────────────────────────

safe-location:
  # Allow landing on the surface of water. Players never land under water,
  # in lava, or on cactus, magma, fire, powder snow or berry bushes.
  allow-water: false

  # Spots tried per RTP for places without their own max-attempts.
  # One spot is tried per tick, so 50 attempts take at most 2.5 seconds.
  max-attempts: 50

# ──────────────────────────────────────────────────────────
#                       HOOKS
# ──────────────────────────────────────────────────────────

hooks:
  # Avoid landing in GriefPrevention claims
  griefprevention: true

  # Avoid landing in Factions territory
  factions: true

  # Avoid landing inside any WorldGuard region (the global region does not count)
  worldguard: true

# ──────────────────────────────────────────────────────────
#                       PLACES
# ──────────────────────────────────────────────────────────
# Each place is an RTP preset that players can teleport to.
# Place names may use letters, digits, - and _.
# Everything except display-name, description and material can also be
# edited in game with /rtp admin → Places.

places:
  wilderness:
    display-name: "<gradient:#2ECC71:#52D68A><bold>Wilderness</bold></gradient>"
    description: "Teleport to a random location in the wilderness"
    material: GRASS_BLOCK         # Icon in the /rtp GUI; leave out to use the icon for the world type (place-gui.icons in messages.yml)
    world: world                  # World players are sent to
    center:                       # Point the radius is measured from
      x: 0
      z: 0
    radius: 5000                  # Furthest a player can land from the center, in blocks
    min-radius: 200               # Closest a player can land to the center, in blocks (keeps them out of spawn)
    cooldown: 300                 # Seconds before the same player can use this place again (0 = none)
    cost: 0                       # Money charged per teleport through Vault (0 = free)
    biome-filter: []              # Only land in these biomes, e.g. [PLAINS, FOREST]; empty = all biomes
    max-attempts: 50              # Spots tried before giving up; leave out to use safe-location.max-attempts
    permission: ""                # Permission needed to use it, e.g. "nexalrtp.place.wilderness"; empty = everyone

  nether:
    display-name: "<gradient:#FF5252:#FF7070><bold>Nether</bold></gradient>"
    description: "Teleport to a random location in the Nether"
    material: NETHERRACK
    world: world_nether
    center:
      x: 0
      z: 0
    radius: 2000
    min-radius: 100
    cooldown: 600
    cost: 0
    biome-filter: []
    max-attempts: 30
    permission: ""

  the_end:
    display-name: "<gradient:#9B59B6:#A569BD><bold>The End</bold></gradient>"
    description: "Teleport to a random location in the End"
    material: END_STONE
    world: world_the_end
    center:
      x: 0
      z: 0
    radius: 3000
    min-radius: 500
    cooldown: 900
    cost: 0
    biome-filter: []
    max-attempts: 30
    permission: ""

# ──────────────────────────────────────────────────────────
#                      STORAGE
# ──────────────────────────────────────────────────────────

storage:
  # Storage type: "json" or "sql"
  type: json

  sql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: ""

Configuration Options​

Below is a reference of the main configuration sections:

default-behavior​

══════════════════════════════════════════════════════════ NEXAL RTP CONFIG ══════════════════════════════════════════════════════════

What /rtp with no arguments does: "gui" or "teleport"

default-place​

Which place to use when default-behavior is "teleport"

warmup​

────────────────────────────────────────────────────────── WARMUP ──────────────────────────────────────────────────────────

safe-location​

────────────────────────────────────────────────────────── SAFE LOCATION ──────────────────────────────────────────────────────────

hooks​

────────────────────────────────────────────────────────── HOOKS ──────────────────────────────────────────────────────────

places​

────────────────────────────────────────────────────────── PLACES ────────────────────────────────────────────────────────── Each place is an RTP preset that players can teleport to. Place names may use letters, digits, - and _. Everything except display-name, description and material can also be edited in game with /rtp admin → Places.

storage​

────────────────────────────────────────────────────────── STORAGE ──────────────────────────────────────────────────────────