GateWayMC-Core

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  📡 Overview
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

The Teleport Module adds a full teleportation system to your server. Players can send teleport requests to each other, teleport to a player, or request someone to teleport to them. Admins have instant teleport commands with bypass options. The module supports configurable cooldowns, economy costs, permission nodes, and saves offline locations for future teleports. All messages support hex colours and PlaceholderAPI placeholders.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  ✨ Features
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

• Teleport requests – /tpa and /tpahere with accept/cancel
• Configurable delay – players must stand still for a set time before teleporting (movement cancels)
• Admin commands – /tp, /tphere, /tpall, /otp (teleport to offline player's last location)
• Economy support – charge players for using commands (optional, requires Vault)
• Cooldown system – per‑command cooldowns to prevent spam
• Permission control – each command can have its own permission node (configurable)
• Offline location saving – when a player logs out, their location is saved for /otp
• PlaceholderAPI support – use placeholders in messages and headers (when installed)
• Hex colour support – use RRGGBB in all messages
• Update checker – notifies console when a new version is available
• Fully configurable messages – all texts can be customised

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  🚀 Installation
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

1. Make sure GateWayMC‑Core is installed and running on a Paper 1.18.2+ server.
2. (Optional) Install Vault for economy integration and PlaceholderAPI for placeholders.
3. Drop the TeleportModule.jar into the modules folder:
   plugins/GateWayMC-Core/modules/
4. Reload the core (or restart the server):
   • In‑game: /gatewaycore reload
   • Console: gatewaycore reload
5. Configuration file config.yml is generated automatically in plugins/GateWayMC-Core/modules/Teleport/
6. Edit settings (delay, cooldowns, economy costs, messages, permissions) and reload the module – no restart needed

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  💬 Commands
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Command	Description	Permission (configurable)
/tpa	Request to teleport to a player	tpmodule.tpa
/tpahere	Request a player to teleport to you	tpmodule.tpahere
/tpaccept	Accept the latest teleport request	tpmodule.tpaccept
/tpacancel	Cancel your own pending request	tpmodule.tpacancel
/tp	Teleport to a player (admin, instant)	tpmodule.tp
/tphere	Teleport a player to you (admin, instant)	tpmodule.tphere
/tpall	Teleport all online players to you (admin, instant)	tpmodule.tpall
/otp	Teleport to offline player's last saved location (admin, instant)	tpmodule.otp

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  🔑 Permissions
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

All permissions are fully configurable in config.yml – you can set them to any node, or leave empty to allow everyone.

Default Node	Command(s)	Default
tpmodule.tpa	/tpa	none (all players)
tpmodule.tpahere	/tpahere	none
tpmodule.tpaccept	/tpaccept	none
tpmodule.tpacancel	/tpacancel	none
tpmodule.tp	/tp	op
tpmodule.tphere	/tphere	op
tpmodule.tpall	/tpall	op
tpmodule.otp	/otp	op

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  ⚙ Configuration (tp-config.yml)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

# Teleport module configuration

# General settings
teleport-delay: 5  # seconds before teleport after accept (0 = instant)
update-check-enabled: true

# Command cooldowns (seconds)
cooldowns:
  tpa: 3
  tpahere: 3
  tp: 0
  tphere: 0
  tpall: 0
  otp: 0

# Costs (if vault-enabled)
vault-enabled: false
costs:
  tpa: 0
  tpahere: 0
  tp: 0
  tphere: 0
  tpall: 0
  otp: 500

# Permission nodes (set to empty to disable permission check for that command)
permissions:
  tpa: "tpmodule.tpa"
  tpahere: "tpmodule.tpahere"
  tpaccept: "tpmodule.tpaccept"
  tpacancel: "tpmodule.tpacancel"
  tp: "tpmodule.tp"
  tphere: "tpmodule.tphere"
  tpall: "tpmodule.tpall"
  otp: "tpmodule.otp"

# Enable/disable specific commands
commands-enabled:
  tpa: true
  tpahere: true
  tpaccept: true
  tpacancel: true
  tp: true
  tphere: true
  tpall: true
  otp: true

# Messages (use & for colors, or RRGGBB for hex)
messages:
  no-permission: "&cYou don't have permission to use this command."
  cooldown: "&cYou must wait &e{time} &cseconds before using this command again."
  insufficient-funds: "&cYou need &e{cost} &cto use this command."
  request-sent: "&aRequest sent to &e{player}&a. They have &e{time} &aseconds to accept."
  request-received: "&e{player} &awants to teleport to you. &7/tpaccept &ato accept, &7/tpacancel &ato cancel."
  request-here-sent: "&aYou asked &e{player} &ato teleport to you. They have &e{time} &aseconds to accept."
  request-here-received: "&e{player} &awants you to teleport to them. &7/tpaccept &ato accept, &7/tpacancel &ato cancel."
  request-expired: "&cTeleport request from &e{player} &cexpired."
  request-accepted: "&aTeleport request accepted. Teleporting..."
  request-cancelled: "&cTeleport request cancelled."
  teleporting: "&aTeleporting..."
  teleport-delay: "&aTeleporting in &e{seconds} &aseconds. Don't move!"
  teleport-cancelled-move: "&cTeleport cancelled because you moved."
  teleport-cancelled-damage: "&cTeleport cancelled because you took damage."
  player-not-found: "&cPlayer not found."
  no-requests: "&cYou have no pending teleport requests."
  teleported-player: "&aTeleported &e{player} &ato you."
  teleported-to: "&aTeleported to &e{player}&a."
  teleported-all: "&aTeleported all players to you."
  offline-location-saved: "&aTeleported to &e{player}&a's last known location."
  offline-location-not-found: "&cCould not find last location for that player."
  cannot-teleport-self: "&cYou cannot teleport to yourself."

Settings explanation

• teleport-delay – seconds a player must stand still before teleporting (movement or damage cancels). Set to 0 for instant.
• update-check-enabled – toggles the startup update checker.
• cooldowns – seconds between uses of each command (per player).
• vault-enabled – if true and Vault is installed, commands cost money as defined in costs.
• costs – amount to charge for each command (ignored if vault-enabled: false).
• permissions – permission node required for each command. Leave empty to allow everyone.
• commands-enabled – enable or disable specific commands without removing the module.
• messages – all texts sent to players. Supports {player}, {time}, {cost} placeholders, and colour codes.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  💾 Offline Teleport (OTP)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

When a player disconnects, their exact location is saved. Admin can use /otp to teleport to that location – perfect for retrieving lost items or investigating offline player positions. Offline locations persist across server restarts.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  🎨 Colour Support
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

All messages support both legacy & colour codes and hex colours with RRGGBB. Examples:

• &a&lSuccess! – green bold text
• FC4D07&lTeleporting... – orange gradient heading

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  ⚙ Dependencies
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

• Required: GateWayMC‑Core
• Optional: Vault – for economy costs
• Optional: PlaceholderAPI – for placeholders in messages (Vault also recommended)

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  ❓ FAQ
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

• Q: Why does teleport get cancelled when I move?
  A: That's the intended behaviour. The delay ensures players don't teleport while moving; they must stand still for the configured time.
• Q: How do I make teleport instant?
  A: Set teleport-delay: 0 in config.
• Q: Can I disable a command without removing the module?
  A: Yes, set the command's entry under commands-enabled to false.
• Q: How does /otp work?
  A: When a player logs out, their location is saved. You can then teleport to that location even if they are offline. Great for checking bases or retrieving items.
• Q: Can I make some commands free and others cost money?
  A: Absolutely. Set vault-enabled: true and adjust the costs section. Set cost to 0 for free commands.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  🔗 Links
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

• GateWayMC‑Core
• Vault
• PlaceholderAPI