Home System

The Home module lets players save named locations and teleport back to them at any time.

Basic Usage

/sethome          → saves current location as "home" (the default name)
/sethome base     → saves current location as "base"
/home             → teleports to "home"
/home base        → teleports to "base"
/homes            → lists all saved homes
/delhome base     → deletes the home named "base"

Home names cannot contain spaces or special characters.

Home Limits & Tiers

Each player has a maximum number of homes determined by their permissions. Tiers are defined in config.yml:

home:
  limits:
    default: 3      # applies to everyone — no permission needed
    vip: 10         # grant teleporterpro.homes.vip
    elite: 25       # grant teleporterpro.homes.elite
    admin: 50       # grant teleporterpro.homes.admin

The highest matching tier wins. A player in both vip and elite gets 25 homes.

teleporterpro.homes.unlimited removes the limit entirely.

Over-Limit Behavior

When a player's limit drops (e.g. a timed VIP rank expires), TeleporterPro handles the excess homes based on over-limit-behavior:

Value	What happens
keep	Excess homes are preserved and still usable, but the player cannot set new homes until they delete down to their limit. A warning message is shown.
delete	Excess homes are removed automatically. The newest homes are deleted first. The player is notified which homes were removed.

Over-Limit Checks

TeleporterPro can detect limit changes via three independent triggers — enable any combination:

home:
  over-limit-checks:
    on-login: true              # checked every time the player joins
    periodic:
      enabled: true
      interval-minutes: 5       # scans all online players every 5 minutes
    luckperms-events:
      enabled: true             # fires instantly when LuckPerms recalculates permissions

The LuckPerms hook is the most responsive — it fires immediately when a rank change or timed permission expires, with no delay.

Warmup

home:
  warmup: 3             # seconds the player must stand still
  cancel-on-move: true  # cancel if they move

Set warmup: 0 for instant teleportation.

Economy

When economy is enabled, each /home use costs economy.home.cost. Dynamic pricing is also supported — see Economy.

Money is checked before the warmup and charged after it completes. If the player can no longer afford the teleport by the time the warmup ends, it is cancelled with no charge.

Multi-World Support

Homes are stored by world name. If a world is deleted or renamed, the home's location becomes inaccessible but the entry is preserved. Players are shown a "world not found" error rather than a confusing crash.