EN 5 2 Home Module

Home Module

中文版本 | English version

Function

This module provides each player with a personal home list, a default home, and runtime home publication/subscription.

Unlike warp, home is fully per-player data. Each player only sees and manages their own homes.

Typical Usage

If the server supports long-term fixed locations such as bases, farms, shops, or outposts, home is usually one of the highest-frequency features. Default home also makes return-to-base more convenient.

Commands

/sethome <name>
/tmphome <name>
/home
/home <name>
/delhome <name>
/renamehome <name> <newName>
/updatehome <name>
/defaulthome <name>
/sharehome <name>
/homes
/homes <page>
/maphome <name> <true|false>
/sharedhome <name>
/sharedhome <name> <disableSafetyCheck>
/sharedhomes
/sharedhomes <page>

Related Config

Mainly related: home.enabled, home.playerMaximum, home.temporaryHomeTtlSeconds, home.sharedHomeMaximum, home.sharedHomeBroadcastCooldownSeconds, home.deleteInvalid, teleporting.delay, teleporting.cooldown, teleporting.preloadEnabled, teleporting.defaultSafetyCheck.

Behavior Notes

When /home is called without a name, default home is used. home.playerMaximum limits how many homes one player can store. With home.deleteInvalid=true, an invalid home is deleted if a home teleport finds that its target world is unavailable. Storage loading preserves homes even if a dimension is not available yet.

Beyond teleport itself, this module includes rename, default assignment, updating an existing home to the current location, and paginated list display with filtering and sorting. Each home management page also provides confirmed deletion, publication, and withdrawal while preserving page, filter, and sort context when returning to the list. The dimension filter accepts raw world ids such as minecraft:overworld, plus the short aliases overworld, nether, and end. Actual teleport execution still follows global delay and cooldown. The default target safety behavior is controlled by teleporting.defaultSafetyCheck, but target safety checks only run when target preloading is enabled.

/sharehome <name> publishes a permanent home and sends a subscription action to players currently online. sharedHomeMaximum limits simultaneous publications per owner, and sharedHomeBroadcastCooldownSeconds limits how frequently one player can broadcast. Subscription count is unlimited. Subscribers can browse /sharedhomes or teleport with /sharedhome <name>. Temporary homes cannot be published.

Publications and subscriptions are runtime state and are not written to player storage; they must be recreated after a server restart. When an owner updates, renames, or deletes a home, UUID identity keeps the publication linked or withdraws it when the source disappears. Shared-home teleport follows the same delay, cooldown, target preload, and default safety rules as normal home teleport.

If map integration is enabled, /maphome <name> <true|false> can control whether one specific home remains visible on the current player's own map. Subscribed shared homes also have personal map-visibility controls in /sharedhomes. These operations do not delete the source home and do not affect other players.

Important Caveats

If default home is not set, /home without argument does not auto-pick one. Also, when a home dimension becomes invalid, whether it is auto-removed during a teleport attempt depends on home.deleteInvalid.