Full reference guide for config.yml settings, teleport timers, sound selectors, particles, and Vault economy costs.

Configuration (`config.yml`)

The config.yml file is generated inside the plugins/SignWarp/ directory. It controls the warp countdown timers, action bar notifications, particle types, audio cues, teleport fees, and all system translations.

Default Configuration File

Here is the exact default structure of the config.yml generated on startup:

# ======================================================
#                 SignWarp Configuration
# ======================================================

# Settings related to teleportation
teleport:
  # Time in seconds before teleporting
  cooldown: 5
  
  # Show an action bar countdown (e.g. "Teleportation in 3s...")
  action-bar: true
  
  # Visuals and Sounds
  sound:
    # Sound played every second during the countdown
    warmup: BLOCK_NOTE_BLOCK_PLING
    # Sound played when teleportation occurs
    success: ENTITY_ENDERMAN_TELEPORT
  
  # Particle effect shown around the player during countdown
  particle: PORTAL

# Costs to use a Warp Sign
costs:
  # Economy cost (requires Vault). Set to 0.0 to disable.
  money: 0.0
  
  # Item cost. Set amount to 0 to disable.
  item:
    material: ENDER_PEARL
    amount: 0

# Custom Messages
# Supports color codes (&).
messages:
  prefix: "&8[&bSignWarp&8] "
  
  error:
    no-permission: "&cYou do not have permission."
    create-permission: "&cYou do not have permission to create warp signs!"
    destroy-permission: "&cYou do not have permission to destroy warp signs!"
    use-permission: "&cYou do not have permission to use this warp!"
    
    no-money: "&cYou don't have enough money ({cost}) to teleport."
    no-item: "&cYou need {amount} {item} to use this warp."
    invalid-item: "&cYou must hold {item} to use this warp."
    
    warp-not-found: "&cThis warp does not exist!"
    warp-exists: "&cA warp with this name already exists!"
    no-warp-name: "&cPlease specify a warp name on the second line."
    
    no-link: "&cNo return point found for this warp!"
    limit-reached: "&cYou have reached your limit of {limit} warps."
    
  success:
    warp-created: "&aWarp sign created successfully."
    target-created: "&aTarget sign created successfully."
    warp-removed: "&aWarp sign removed."
    warp-deleted: "&cWarp deleted from database."
    
    teleport-start: "&eTeleporting in {time}s..."
    teleport-done: "&aTeleported to {warp}!"
    teleport-cancelled: "&cTeleportation cancelled."
    transaction: "&aYou paid {cost} for this teleport."

Configuration Breakdown

1. Teleportation Settings

teleport.cooldown : Warmup delay (in seconds) before the teleport executes. Set to 0 for instant travel.
teleport.action-bar : When enabled (true), shows a ticking countdown directly above the hotbar (e.g. Teleportation in 3s...).
teleport.sound.warmup : Sound played once a second during the countdown delay. Accepts any valid Bukkit Sound key.
- Example: BLOCK_NOTE_BLOCK_PLING, UI_BUTTON_CLICK.
teleport.sound.success : Sound played at the destination coordinates when the player arrives.
- Example: ENTITY_ENDERMAN_TELEPORT, ENTITY_ENDER_DRAGON_GROWL.
teleport.particle : The particle cloud spawned surrounding the player during the warmup phase.
- Example: PORTAL, FLAME, DRIPPING_OBSIDIAN, HAPPY_VILLAGER.

Teleport Cost Models

SignWarp features two distinct cost methods that can be enabled separately or combined depending on your server economy model.

1. Vault Economy Fees

Charge in-game currency to right-click warp signs. Set costs.money to any positive floating-point value.

Setup:

costs:
  money: 25.50
  item:
    material: ENDER_PEARL
    amount: 0

Requirement: Requires Vault and an active economy provider (like EssentialsX Economy).
Behavior: The plugin validates the player's balance. If sufficient, the countdown begins. The funds are only deducted after successful teleportation.

2. Physical Item Requirements

Force players to hold a specific quantity of an item in their main hand to unlock the teleportation sign.

Setup:

costs:
  money: 0.0
  item:
    material: ENDER_PEARL
    amount: 1

Requirement: The player must be holding the designated Material key in their active hand.
Behavior: Checks the held stack size. If it matches, the countdown starts. Items are subtracted after successful teleportation from the main hand stack.

3. Dual Payment Check

If both options are configured above zero, players must satisfy both criteria to teleport.

Setup:

costs:
  money: 5.0
  item:
    material: ENDER_PEARL
    amount: 1

Behavior: Requires both $5.00 Vault cash AND 1 Ender Pearl. If either condition fails, the teleport cancels with descriptive chat notifications.

Translation Variables

The text strings inside messages support standard legacy color codes (&) and carry dynamic text placeholders:

{cost} : The money subtracted for the teleport (e.g. 25.5).
{amount} : The number of items required (e.g. 3).
{item} : The item type required (e.g. ENDER_PEARL).
{time} : Cooldown warmup length (e.g. 5).
{warp} : The target warp destination name (e.g. spawn).
{limit} : The player's maximum warp creation limit (e.g. 3).

Configuration

On this page