Page cover image

Configuration

In this case we have 2 configurations (the general one and the individual one for each warp).

Individual configuration

When creating a warp (/setwarp) a dedicated file is created in the data/warps folder. In this file you can configure actions and conditions for that specific warp (actions and conditions from the general configuration are also taken into account).

Example of a warp:

world: dd2161ec-1c1e-49d8-8f5e-ea3d54b02194
world_name: world
x: 50.62816450855759
y: 67.0
z: -77.76705649090842
yaw: 11.101776
pitch: 19.350039
name: enchantments
lastowner: 0a2cbc07-a6d6-4d05-8f05-98d069adbd0e
teleport_actions:
  actions:
    message:
      type: message
      when: none, after_delay
      message: "&aTeleporting in &bEnchantments"
teleport_conditions:
  conditions:
    permission:
      type: permission
      permission: deluxeteleport.warp.enchantments

You can consult the documentation on the actions [HERE].

You can consult the documentation on conditions [HERE].

General settings

Below I will introduce you to each feature of the Warps configuration. This configuration is available in the configs/warps.yml file, where you can make adjustments.

Will warps be enabled?

enabled_settings:
enabled: true

This option determines whether the feature is enabled. If set to false, players will receive a message indicating that this feature is disabled.

force_disable: false

Setting this option to true will disable the feature completely, as if it didn't exist in the plugin. This is useful if you have another plugin that handles this functionality. If not, do not enable this option. Please note that a server restart is required for the changes to take effect.

Will commands have priority?

high_priority: false

You can set this to true if there is another plugin interfering with the commands for this DeluxeTeleport feature and it will try to pass them through, the only problem with this is that the tab (chat autocomplete) may not work correctly according to DeluxeTeleport and you will have to fix this with the plugin that is causing the interference.

Command Aliases

commands_alias:
warp: []

Alias ​​for the /warp command

warps:
  - warplist

Alias ​​for the /warps command

Delay in teleportation

teleport_delay:
enabled: true

Enables or disables teleportation delay.

time: 3s

Defines how much delay time will be applied (you can see what time formats to use [HERE]).

cancel_on_move: true

Determines whether the teleport should be cancelled if the player moves during the cooldown.

Cooldown in teleportation

cooldown:
enabled: true

Enables or disables the timeout between each use of the /warp command. If set to true, the cooldown will be enabled.

time: 10m

Sets the cooldown time between each use of the command (you can see what time formats to use [HERE]).

by_rank:
enabled: true

Enables or disables the ranged cooldown functionality.

ranks:

Each range is defined with a name and a time format (you can see what time formats to use [HERE]).

vip: 5m

For example, vip has a 5 minute cooldown.

auto_ranks:

Setting to automatically assign permissions based on player rank.

enabled: true

If enabled (true), cooldowns will be automatically assigned to users with a compatible permissions plugin.

permissions_plugin: LuckPerms

Specifies the permissions plugin to use for automatic assignment. Currently only LuckPerms is available.

prioritize_time: SHORTEST

Indicates whether the longer or shorter time should be used if a user has more than one cooldown time assigned.

  • Available options are LONGEST or SHORTEST.

save_playerdata: true

If set to true, cooldown data will be saved to a local database (data/sql/cooldowns.db), meaning it will not be lost when the server is shut down.

Conditions

teleport_conditions:
conditions: []

In this section you can define conditions to be met before teleporting, you can perform actions if a condition is met or even if it is not met.

You can see how to use the conditions [HERE].

Actions

teleport_actions:
actions: []

In this section, you can define actions that will be executed before, during, or after the player teleports. These actions allow you to further customize the teleportation process.

You can learn how to configure actions in detail in the corresponding section of this documentation [HERE].

Last updated

Was this helpful?