The Home module provides the ability for players to set personal warps. The number of homes can be limited through the use of a compatible permissions plugin, such as PermissionsEx.
By default, all users will only be able to set one home. This can be changed by using a permissions plugin that supports setting options.
You can set an arbitary number of homes by setting the option home-count
to the number of homes you wish the player/group
to have.
For users:
For groups:
Consult the permissions plugin’s documentation for more information on how to do this. If you wish a player to have an
unlimited number of homes, set the permission nucleus.home.set.unlimited
.
This can be achieved using the commands.conf
file. The options are home.warmup
and home.cooldown
, and are specified
in seconds. Note that if the selected home doesn’t exist, then neither the warmup or the cooldown will start.
If the player moves, runs a command or is attacked during the warmup, the warp home is cancelled.
The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.
Reason: ProjectWorlds has world access permissions that can block cross world teleports.
Resolution: Grant users the ProjectWorlds world access permission, which is "pjw.worlds.<worldname>".
Reason: Topography has the ability to take control of cross-world teleports in non-standard configurations. SkyFactory 4 has some worlds with this option enabled by default, which blocks the Nucleus teleport commands
Resolution: Check topography configuration files for any "captureTeleports" options and remove them.
Reason: ProjectPortals may override some teleport related commands such as `/back`, `/warp` and `/home` if some of the ProjectPortals modules are enabled.
Resolution: Disable the module affecting the commands in PJP or prefix the command with "n", that is, "/back" -> "/nback".
A home is a personal warp. They can be set using the /homeset command. If no home name is specified, the default of "home" is used.
Aliases:
/home
Usage: /home [<home>]
Default Role: USER
Basic Command Permission: nucleus.home.base
Permissions
nucleus.home.exempt.cost
- Default Role: ADMIN nucleus.home.exempt.samedimension
- Default Role: ADMIN nucleus.home.exempt.cooldown
- Default Role: ADMIN nucleus.home.exempt.warmup
- Default Role: ADMIN nucleus.home.base
- Default Role: USER
This command is an equivalent to the following command(s) in Essentials:
/home
, /homes
Essentials Migration Notes: '/homes' will list homes, '/home' will teleport like Essentials did.
Removes a personal warp. The home must be specified.
Aliases:
/home delete
, /home del
Root command aliases:
/deletehome
/ndeletehome
/delhome
/ndelhome
Usage: /home delete <home>
Default Role: USER
Basic Command Permission: nucleus.home.base
Permissions
nucleus.home.base
- Default Role: USER
This command is an equivalent to the following command(s) in Essentials:
/delhome
, /remhome
, /rmhome
Aliases:
/home deleteother
, /home delother
Root command aliases:
/deletehomeother
/ndeletehomeother
/delhomeother
/ndelhomeother
Usage: /home deleteother <user> <home>
Default Role: ADMIN
Basic Command Permission: nucleus.home.deleteother.base
Permissions
nucleus.home.deleteother.base
- Default Role: ADMIN
Aliases:
/home limit
Usage: /home limit [<user>]
Default Role: USER
Basic Command Permission: nucleus.home.limit.base
Permissions
nucleus.home.limit.base
- Default Role: USER nucleus.home.limit.others
- Default Role: ADMIN Lists all the homes that you currently have.
Aliases:
/home list
Root command aliases:
/listhomes
/nlisthomes
/homes
/nhomes
Usage: /home list [<user>]
Default Role: USER
Basic Command Permission: nucleus.home.list.base
Permissions
nucleus.home.list.others
- Default Role: ADMIN nucleus.home.list.base
- Default Role: USER
Aliases:
/home other
Root command aliases:
/homeother
/nhomeother
Usage: /home other <user> <home>
Default Role: MOD
Basic Command Permission: nucleus.home.other.base
Permissions
nucleus.home.other.base
- Default Role: MOD nucleus.home.other.exempt.cost
- Default Role: ADMIN nucleus.home.other.exempt.cooldown
- Default Role: ADMIN nucleus.home.other.exempt.warmup
- Default Role: ADMIN
This command allows players to specify a "personal warp", which is termed a "home". By default, all players get one home, which can be controlled by assigning a number to the permission option "home-count", of being giving the permission "nucleus.home.set.unlimited" for unlimited homes.
If no home name is specified, the default of "home" is used. If you try to set a home with a name that is already in use, the command will fail, unless the "-o" flag is specified.
Aliases:
/home set
Root command aliases:
/homeset
/nhomeset
/sethome
/nsethome
Usage: /home set [-o|--overwrite <o>] [<home>]
Default Role: USER
Basic Command Permission: nucleus.home.set.base
Permissions
nucleus.home.set.exempt.cost
- Default Role: ADMIN nucleus.home.set.base
- Default Role: USER nucleus.home.set.unlimited
- Default Role: ADMIN nucleus.home.set.exempt.warmup
- Default Role: ADMIN nucleus.home.set.exempt.cooldown
- Default Role: ADMIN
This command is an equivalent to the following command(s) in Essentials:
/sethome
, /createhome
Permission | Suggested Role | Description |
---|---|---|
nucleus.home.base | USER | Allows the user to run the command /home delete |
nucleus.home.deleteother.base | ADMIN | Allows the user to run the command /home deleteother |
nucleus.home.exempt.cooldown | ADMIN | Allows the user to bypass the cooldown for /home |
nucleus.home.exempt.cost | ADMIN | Allows the user to bypass the cost for /home |
nucleus.home.exempt.samedimension | ADMIN | If granted, players can teleport across dimensions even when only-same-dimension is enabled. |
nucleus.home.exempt.warmup | ADMIN | Allows the user to bypass the warmup for /home |
nucleus.home.limit.base | USER | Allows the user to run the command /home limit |
nucleus.home.limit.others | ADMIN | Allows the user to target other players using the command "limit". |
nucleus.home.list.base | USER | Allows the user to run the command /home list |
nucleus.home.list.others | ADMIN | Allows the user to target other players using the command "{0}". |
nucleus.home.other.base | MOD | Allows the user to run the command /home other |
nucleus.home.other.exempt.cooldown | ADMIN | Allows the user to bypass the cooldown for /home other |
nucleus.home.other.exempt.cost | ADMIN | Allows the user to bypass the cost for /home other |
nucleus.home.other.exempt.target | ADMIN | If granted, other players cannot warp to your homes using /homeother |
nucleus.home.other.exempt.warmup | ADMIN | Allows the user to bypass the warmup for /home other |
nucleus.home.set.base | USER | Allows the user to run the command /home set |
nucleus.home.set.exempt.cooldown | ADMIN | Allows the user to bypass the cooldown for /home set |
nucleus.home.set.exempt.cost | ADMIN | Allows the user to bypass the cost for /home set |
nucleus.home.set.exempt.warmup | ADMIN | Allows the user to bypass the warmup for /home set |
nucleus.home.set.unlimited | ADMIN | Allows the user to have an unlimited number of homes. |
# If true, when a player is in a different dimension than the designated home, then this player will require the nucleus.home.exempt.samedimension permission to be able to use that home. only-same-dimension=false # If true, if a player has more homes than the permission option "home-count" allows, then players will not be able to use any homes until they delete homes to be at the limit again. prevent-home-count-overhang=true # If true, on respawn, a player will spawn back at their default home (named "home") if it exists. respawn-at-home=false # If true, Nucleus will attempt to ensure that users do not get warped into an unsafe situation (for example, if someone breaks blocks around a home). use-safe-warp=true