Module: Warp - Module ID: warp

Some mods or plugins may conflict with this module

The highest rating mod/plugin compatibility issue is rated major. See the compatibility tab for more information.

Introduction

The warp module allows you to define public facing warps for your players to use.

Per-warp permissions

Nucleus assigns a permission for each warp. Users MUST have the permission for the SPECIFIC warp to view and use a warp, as well as the general permission to perform an action.

Each warp will be assigned the permission nucleus.warps.[warp name] (where [warp name] is replaced with the name of your warp lowercase). The player will be required to have before using it. You will also need to ensure they have access to the warp command if that it how you want them to use the warps - nucleus.warp.base.

For example, if you have the warp warp1, a user will need both nucleus.warps.warp1 and nucleus.warp.base permissions.

Adding costs to warps

If you wish to charge for a particular warp, you can set the cost of a warp using the command

/warp cost <warp> <cost>

If you want to set a default cost of a warp, you can set the configuration entry warp.default-warp-cost in main.conf. Those with the nucleus.warp.exempt.cost permission will be exempt from any cost.

Setting warp categories

If the option warp.list-warps-by-category is set to true, warps can be displayed in categories in /warp list. To set a category for a warp, you can use the command:

/warp setcategory [-n] [-r] <warp> [<category>]

-n indicates that you want to add a new category to the list, if you don’t use this flag and the category doesn’t exist yet, you’ll be prompted to add this flag to confirm the creation.
-r indicates you want to remove the category from the warp.

Adding descriptions for warps and warp categories

Warp categories can have descriptions and display names, which also accept colour codes. They will be displayed on the /warps list, and can be managed using the following commands.

/warp category list - lists all categories
/warp category setdisplayname [category] [& encoded name] - sets a display name for a category.
/warp category setdescription [category] [& encoded description] - sets a description for a category.
/warp category removedisplayname [category] - removes the display name for a category.
/warp category removedescription [category] - removes the description for a category.

Running the following commands for a category named “test”:

/warp category setdisplayname test "&4Test &7Category"
/warp category setdescription test "&bThis is a &ltest description"

gives the following.

warpcat

Warps can also have their own description, but for space reasons, these descriptions will be put into the hover that appears when you hover over a warp link. They can be set using the following command (or use -r to remove the description):

/warp setdescription [-r] [warp] [& encoded description]

So, on warp “hello2”, running the command /warp setdescription hello2 "This is the warp location &awhere you will be greeted with a sunny disposition and a gentle wave of a hand!" give the result:

warp

If you would rather put the description in the main menu, and have the cost/location appear in the tooltip, set warp.show-warp-description-in-list to true in main.conf.

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.

What do the compatibility levels mean?

Critical issues are where some function of Nucleus is seriously affected in a way server owners are not expecting and have no known workaround, other than removing the plugin in question. It is advised that server owners remove the plugin in question and find an alternative if they wish to use the Nucleus feature it affects.
Major issues are where some function of Nucleus is seriously affected in a way server owners are not expecting by default but a workaround exists to mitigate or fix the issue.
Minor issues are where some function of Nucleus can be mildy affected, possibly in an unwanted way, but is not enabled by default or has little impact on day to day server running and management. A workaround exists to restore or use the affected Nucleus functionality.
Info issues are really non-issues. Incompatibilities with this label tend to be wanted (such as a world management plugin taking over the `/world` command), and are documented here for completeness, along with how to restore or use Nucleus functions.

Mod/Plugin: ProjectWorlds. Affected Module(s): teleport, back, home, warp, spawn.

Cross world teleports, such as those via warping or returning to spawn via command, might be canceled by ProjectWorlds with a no permissions message

Major

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>".

Mod/Plugin: Topography. Affected Module(s): teleport, back, home, warp, spawn.

Topography may block cross-world teleports

Minor

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.

Mod/Plugin: ProjectPortals. Affected Module(s): teleport, back, home, warp.

ProjectPortals takes over some teleport related commands in non-default scenarios

Info

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".

/warp

Module: warp

Teleport to the specified warp.

Aliases: warp

Root command aliases: /nwarp

Usage: /warp [[-y|-a|--accept] [-f|--force] ] [<player>] <warp>

Available subcommands: set, cost, setcategory, category, list, delete, setdescription

Default Role: USER

Basic Command Permission: nucleus.warp.base

Permissions

nucleus.warp.others - Default Role: ADMIN
Allows the user to target other players using the command "warp".
nucleus.warp.exempt.cooldown - Default Role: ADMIN
Allows the user to bypass the cooldown for /warp
nucleus.warp.exempt.warmup - Default Role: ADMIN
Allows the user to bypass the warmup for /warp
nucleus.warps - Default Role: ADMIN
Allows the user to access all warps if per-warp permissions is turned on.
nucleus.warp.base - Default Role: USER
Allows the user to run the command /warp

This command is similar to the following command(s) found in Essentials: /warp, /warps

Essentials Migration Notes: Use '/warp' for warping, '/warps' to list warps.

/warp category

Module: warp

Base command for category management.

Aliases: warp category

Usage: /warp category

Available subcommands: removedescription, removedisplayname, setdisplayname, list, setdescription

Default Role: ADMIN

Basic Command Permission: nucleus.warp.category.base

Permissions

nucleus.warp.category.exempt.warmup - Default Role: ADMIN
Allows the user to bypass the warmup for /warp category
nucleus.warp.category.exempt.cost - Default Role: ADMIN
Allows the user to bypass the cost for /warp category
nucleus.warp.category.exempt.cooldown - Default Role: ADMIN
Allows the user to bypass the cooldown for /warp category
nucleus.warp.category.base - Default Role: ADMIN
Allows the user to run the command /warp category

/warp category list

Module: warp

Lists all the warp categories in use on the server.

Aliases: warp category list

Usage: /warp category list

Default Role: ADMIN

Basic Command Permission: nucleus.warp.category.list.base

Permissions

nucleus.warp.category.list.base - Default Role: ADMIN
Allows the user to run the command /category list

/warp category removedescription

Module: warp

Removes the description for a category.

Aliases: warp category removedescription

Usage: /warp category removedescription <category>

Default Role: ADMIN

Basic Command Permission: nucleus.warp.category.description.base

Permissions

nucleus.warp.category.description.base - Default Role: ADMIN
Allows the user to run the command /category removedescription, Allows the user to run the command /category setdescription

/warp category removedisplayname

Module: warp

Removes the display name for a category.

Aliases: warp category removedisplayname

Usage: /warp category removedisplayname <category>

Default Role: ADMIN

Basic Command Permission: nucleus.warp.category.displayname.base

Permissions

nucleus.warp.category.displayname.base - Default Role: ADMIN
Allows the user to run the command /category removedisplayname, Allows the user to run the command /category setdisplayname

/warp category setdescription

Module: warp

Sets the description for a category.

Aliases: warp category setdescription

Usage: /warp category setdescription <category> <description>

Default Role: ADMIN

Basic Command Permission: nucleus.warp.category.description.base

Permissions

nucleus.warp.category.description.base - Default Role: ADMIN
Allows the user to run the command /category removedescription, Allows the user to run the command /category setdescription

/warp category setdisplayname

Module: warp

Sets a display name for a category.

Aliases: warp category setdisplayname

Usage: /warp category setdisplayname <category> <displayname>

Default Role: ADMIN

Basic Command Permission: nucleus.warp.category.displayname.base

Permissions

nucleus.warp.category.displayname.base - Default Role: ADMIN
Allows the user to run the command /category removedisplayname, Allows the user to run the command /category setdisplayname

/warp cost

Module: warp

Set the cost of the specified warp.

Aliases: warp cost warp setcost

Usage: /warp cost <warp> <cost>

Default Role: ADMIN

Basic Command Permission: nucleus.warp.cost.base

Permissions

nucleus.warp.cost.base - Default Role: ADMIN
Allows the user to run the command /warp cost

/warp delete

Module: warp

Deletes the specified warp.

Aliases: warp delete warp del

Usage: /warp delete <warp>

Default Role: ADMIN

Basic Command Permission: nucleus.warp.delete.base

Permissions

nucleus.warp.delete.exempt.cooldown - Default Role: ADMIN
Allows the user to bypass the cooldown for /warp delete
nucleus.warp.delete.exempt.warmup - Default Role: ADMIN
Allows the user to bypass the warmup for /warp delete
nucleus.warp.delete.exempt.cost - Default Role: ADMIN
Allows the user to bypass the cost for /warp delete
nucleus.warp.delete.base - Default Role: ADMIN
Allows the user to run the command /warp delete

This command is an equivalent to the following command(s) in Essentials: /delwarp, /remwarp, /rmwarp

/warp list

Module: warp

Lists all warps on the server.

Aliases: warp list

Root command aliases: /warps

Usage: /warp list [-u]

Default Role: USER

Basic Command Permission: nucleus.warp.list.base

Permissions

nucleus.warp.list.base - Default Role: USER
Allows the user to run the command /warp list
nucleus.warp.list.exempt.cooldown - Default Role: ADMIN
Allows the user to bypass the cooldown for /warp list
nucleus.warp.list.exempt.warmup - Default Role: ADMIN
Allows the user to bypass the warmup for /warp list
nucleus.warp.list.exempt.cost - Default Role: ADMIN
Allows the user to bypass the cost for /warp list

/warp set

Module: warp

Sets a warp.

Aliases: warp set

Root command aliases: /setwarp /warpset

Usage: /warp set <warp>

Default Role: ADMIN

Basic Command Permission: nucleus.warp.set.base

Permissions

nucleus.warp.set.exempt.warmup - Default Role: ADMIN
Allows the user to bypass the warmup for /warp set
nucleus.warp.set.base - Default Role: ADMIN
Allows the user to run the command /warp set
nucleus.warp.set.exempt.cooldown - Default Role: ADMIN
Allows the user to bypass the cooldown for /warp set
nucleus.warp.set.exempt.cost - Default Role: ADMIN
Allows the user to bypass the cost for /warp set

This command is an equivalent to the following command(s) in Essentials: /setwarp, /createwarp

/warp setcategory

Module: warp

Sets the category of a warp for display in /warp list.

Warp categories allow server owners to organise their warps into categories in /warp list - which are case sensitive.

There are two important flags to be aware of:
* -n/--new: This command will only let you create a category if you specify this flag. This is to ensure that if a category does exist but with a different case, this may catch it.
* -r/--remove: Remove the category on the warp, move it back to the default "Uncategorised" group.

Aliases: warp setcategory

Usage: /warp setcategory [-n|--new] [-r|--remove|--delete] <warp> [<category>]

Default Role: ADMIN

Basic Command Permission: nucleus.warp.setcategory.base

Permissions

nucleus.warp.setcategory.base - Default Role: ADMIN
Allows the user to run the command /warp setcategory

/warp setdescription

Module: warp

Sets or removes (with -r) the description for the warp.

Aliases: warp setdescription

Usage: /warp setdescription [-r|--remove|--delete] <warp> [<description…>]

Default Role: ADMIN

Basic Command Permission: nucleus.warp.setdescription.base

Permissions

nucleus.warp.setdescription.base - Default Role: ADMIN
Allows the user to run the command /warp setdescription

Permission	Suggested Role	Description
nucleus.warp.base	USER	Allows the user to run the command /warp
nucleus.warp.category.base	ADMIN	Allows the user to run the command /warp category
nucleus.warp.category.description.base	ADMIN	Allows the user to run the command /category removedescription, Allows the user to run the command /category setdescription
nucleus.warp.category.displayname.base	ADMIN	Allows the user to run the command /category removedisplayname, Allows the user to run the command /category setdisplayname
nucleus.warp.category.exempt.cooldown	ADMIN	Allows the user to bypass the cooldown for /warp category
nucleus.warp.category.exempt.cost	ADMIN	Allows the user to bypass the cost for /warp category
nucleus.warp.category.exempt.warmup	ADMIN	Allows the user to bypass the warmup for /warp category
nucleus.warp.category.list.base	ADMIN	Allows the user to run the command /category list
nucleus.warp.cost.base	ADMIN	Allows the user to run the command /warp cost
nucleus.warp.delete.base	ADMIN	Allows the user to run the command /warp delete
nucleus.warp.delete.exempt.cooldown	ADMIN	Allows the user to bypass the cooldown for /warp delete
nucleus.warp.delete.exempt.cost	ADMIN	Allows the user to bypass the cost for /warp delete
nucleus.warp.delete.exempt.warmup	ADMIN	Allows the user to bypass the warmup for /warp delete
nucleus.warp.exempt.cooldown	ADMIN	Allows the user to bypass the cooldown for /warp
nucleus.warp.exempt.warmup	ADMIN	Allows the user to bypass the warmup for /warp
nucleus.warp.list.base	USER	Allows the user to run the command /warp list
nucleus.warp.list.exempt.cooldown	ADMIN	Allows the user to bypass the cooldown for /warp list
nucleus.warp.list.exempt.cost	ADMIN	Allows the user to bypass the cost for /warp list
nucleus.warp.list.exempt.warmup	ADMIN	Allows the user to bypass the warmup for /warp list
nucleus.warp.others	ADMIN	Allows the user to target other players using the command "warp".
nucleus.warp.set.base	ADMIN	Allows the user to run the command /warp set
nucleus.warp.set.exempt.cooldown	ADMIN	Allows the user to bypass the cooldown for /warp set
nucleus.warp.set.exempt.cost	ADMIN	Allows the user to bypass the cost for /warp set
nucleus.warp.set.exempt.warmup	ADMIN	Allows the user to bypass the warmup for /warp set
nucleus.warp.setcategory.base	ADMIN	Allows the user to run the command /warp setcategory
nucleus.warp.setdescription.base	ADMIN	Allows the user to run the command /warp setdescription
nucleus.warps	ADMIN	Allows the user to access all warps if per-warp permissions is turned on.

The following configuration is the default for this module:

default-category-name=Uncategorised
# The default cost for a warp. Can be overriden using /warp setcost <warp> <cost>
default-warp-cost=0.0
# If true, warps will be displayed by category in /warp list.
list-warps-by-category=false
# If this is set to true, each warp has its own permission node - nucleus.warps.<name>.
# 
# NOTE: This option will be removed inNucleus v2 and will act as if it's "true". Use the permission node "nucleus.warps" to emulate this being "false".
separate-permissions=true
# If true, the warp description will be shown in /warp list, and the co-ords will be shown in the tooltip on hover.
show-warp-description-in-list=false
# If true, using /warp will attempt to find a safe place. If false, the teleportation will always directly send the player to the location with no safety checks.
use-safe-warp=true