Skip to main content

Installation

Requirementsโ€‹

RequirementMinimum version
Paper or Folia1.21
Java21

TeleporterPro does not work on CraftBukkit or Spigot. It requires the async teleport APIs introduced in Paper.

Installing the Pluginโ€‹

  1. Download TeleporterPro-x.x.x.jar.
  2. Place it in your server's plugins/ folder.
  3. Restart the server (or use a plugin manager that supports hot-loading).

On first start, the plugin creates:

plugins/TeleporterPro/
config.yml
messages.yml
homes.yml
warps.yml

Optional Dependenciesโ€‹

These are all soft-depends. The plugin starts and works without any of them โ€” features that require a missing plugin are simply skipped.

Vault (Economy)โ€‹

Install Vault plus any Vault-compatible economy plugin:

  • EssentialsX Economy
  • CMI
  • PlayerPoints
  • Any Vault-compatible plugin

Then enable economy in config.yml:

economy:
enabled: true

PlaceholderAPIโ€‹

Install PlaceholderAPI and TeleporterPro will register its placeholders automatically on startup. No additional configuration required.

Landsโ€‹

Install Lands and ensure integrations.lands.enabled: true in config.yml (it is by default). TeleporterPro will hook into Lands automatically.

LuckPermsโ€‹

Install LuckPerms and ensure home.over-limit-checks.luckperms-events.enabled: true in config.yml. The hook activates automatically.

Geyser / Floodgateโ€‹

Install Floodgate (the Floodgate component of Geyser). TeleporterPro detects it on startup and enables Bedrock form support automatically.

Verifying the Installationโ€‹

Check the server console on startup. You should see:

[TeleporterPro] TeleporterPro enabled (Paper/Folia 1.21+).

With optional dependencies present, you'll also see lines like:

[TeleporterPro] PlaceholderAPI integration enabled.
[TeleporterPro] Lands integration enabled โ€” land entry checks active.
[TeleporterPro] Floodgate detected - Geyser Bedrock form support enabled.
[TeleporterPro] LuckPerms permission-change hook enabled for home enforcement.

Updatingโ€‹

  1. Stop the server.
  2. Replace the old jar with the new one.
  3. Start the server.

TeleporterPro does not migrate config files automatically. Check the changelog for any new config keys and add them manually if needed.

Uninstallingโ€‹

  1. Remove the jar from plugins/.
  2. Optionally delete the plugins/TeleporterPro/ folder (contains homes and warp data).