Quickstart

Get TeleporterPro running on your server in under 5 minutes.

Step 1 — Drop the Jar

Place TeleporterPro-x.x.x.jar into your server's plugins/ folder.

Step 2 — Start the Server

Start or restart the server. TeleporterPro will generate its config files automatically:

plugins/TeleporterPro/
  config.yml       ← main settings
  messages.yml     ← all player-facing text (MiniMessage)
  homes.yml        ← player home data
  warps.yml        ← warp data

Step 3 — Test the Basics

Log in and try a few commands:

/tpa <player>        → send a TPA request to someone
/sethome             → save your current location as "home"
/home                → teleport back to it
/setwarp spawn       → create a warp named "spawn"
/warp spawn          → use it

Step 4 — Configure to Taste

Open config.yml and adjust the key settings:

Setting	What it does
modules.tpa/home/warp	Disable an entire module
tpa.warmup / home.warmup / warp.warmup	Warmup seconds (0 = instant)
tpa.cancel-on-move	Cancel warmup if the player moves
home.limits	Set named home-count tiers for rank groups
economy.enabled	Enable economy charges (requires Vault)
gui.player-selector	Show player-picker GUI for /tpa with no arguments

Apply all changes without a restart:

/tpreload

Step 5 — Set Up Home Limits (Optional)

Define home-count tiers in config.yml and assign permissions in your permission plugin:

# config.yml
home:
  limits:
    default: 3    # everyone
    vip: 10       # teleporterpro.homes.vip
    admin: 50     # teleporterpro.homes.admin

# LuckPerms example
/lp group vip permission set teleporterpro.homes.vip true
/lp group admin permission set teleporterpro.homes.admin true

Players with teleporterpro.homes.unlimited have no limit at all.

Step 6 — Enable Economy (Optional)

1. Install Vault + an economy plugin (e.g. EssentialsX Economy, CMI).
2. Set economy.enabled: true in config.yml.
3. Set costs under economy.tpa.cost, economy.home.cost, economy.warp.default-cost, etc.
4. Run /tpreload.

Players now see a Payment Confirmation GUI before sending a paid request. Money is checked immediately but only deducted after the warmup finishes.

That's It!

Next step	Link
Full config reference	Configuration
All commands	Commands
Permissions setup	Permissions
Economy & dynamic pricing	Economy