EN 5 2 Home Module

Home Module

中文版本 | English version

Function

This module provides each player with a personal home list and supports a default home.

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>
/home
/home <name>
/delhome <name>
/renamehome <name> <newName>
/updatehome <name>
/defaulthome <name>
/homes
/homes <page>
/maphome <name> <true|false>

Related Config

Mainly related: home.enabled, home.playerMaximum, home.deleteInvalid, teleporting.delay, teleporting.cooldown.

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, invalid homes are cleaned during storage load.

Beyond teleport itself, this module includes complete management operations: rename, delete, default assignment, updating an existing home to the current location, and paginated list display. Actual teleport execution still follows global delay and cooldown.

If Xaero integration is enabled, /maphome <name> <true|false> can also control whether one specific home remains visible on the current player's own map. This does not delete the home and does 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 depends on home.deleteInvalid.