1. Introduction

The Warps module let you set fully customizable warps, with custom menus to modify settings, such as the sound, bossbar, title, and much more. All the functionnalities are available directly when installing the plugin on your server, no need to install anything else to enable more features

2. Setup

modules:
        warps: true

3. Commands

Here are the available commands with the Warps module.

The only parameters for this module are the default values of created warps. Here is the list

4. Configuration

Sounds:

* The only available values for Sound type are the following. Sounds may be added if they are requeste on Github (put link to git requests here - not created repo for now).

• BLOCK_AMETHYST_BLOCK_CHIME - Amethyst
• BLOCK_BEACON_POWER_SELECT - Beacon activating
• BLOCK_BELL_USE - Using a bell
• BLOCK_NOTE_BLOCK_PLING - Pling note block (Glowstone)
• BLOCK_NOTE_BLOCK_BELL - Bell note block (gold block)
• BLOCK_NOTE_BLOCK_CHIME - Chime note block (Packed ice)
• BLOCK_NOTE_BLOCK_GUITAR - Guitar note block (Wool)
• BLOCK_NOTE_BLOCK_HARP - Harp note block (default note block)
• BLOCK_NOTE_BLOCK_HAT - Hat note block (Glass)
• BLOCK_END_PORTAL_FRAME_FILL -
• BLOCK_PORTAL_AMBIENT - Nether portal Ambient sound
• BLOCK_PORTAL_TRAVEL - Nether portal after teleportation
• BLOCK_PORTAL_TRIGGER - Nether portal teleporting
• ITEM_TOTEM_USE - Totem of undying breaking sound
• UI_BUTTON_CLICK - UI button click
• ENTITY_EXPERIENCE_ORB_PICKUP - Experience orb pickup
• BLOCK_ENCHANTMENT_TABLE_USE - Using enchantement table

Bossbar:

Available values for default.bossbar.when:

• COMMAND - When the command is executed.
• TELEPORTED - After teleportation
• COUNTDOWN - When the countdown start (3s before teleportation).

The available values for default.bossbar.type are PROGGRESS, which is a simple clean bar, NOTCHED_6, NOTCHED_10, NOTCHED_12, and NOTCHED_20, which correspond to a bar notched in respectively to 6, 10, 12, and 20 segments.

The available values for default.bossbar.color are BLUE, GREEN, PINK, PURPLE, RED, WHITE, and YELLOW. they need to be in upper case

Title:

You can use both PlaceholderAPI's placeholders and internal placeholders, which are in the list below in the bossbar text in the custom inputs for warps texts (title and bossbar only). Note also that for title and bossbar text inputs, colors are automatically handled.

• {WARP} - The name of the warp.
• {TIME} - The player delay before teleportation (not dynamic).
• {USED} - The number of time this warp was used.

6. Permisssions

Here is the list of all the permission for the Warps module:

5. Placeholders

Here are the available placeholders with the Warps module. The plugin PlaceholderAPI need to be installed on your server for them to work. Note that it's not the name, but the Identifier of the warp that need to be in the placeholder. if you put the name, it might not work.

unessentials_warp_enabled_<warp_identifier> - "true" if the warp is enabled. "false" otherwise
unessentials_warp_name_<warp_identifier> - The name of the warp
unessentials_warp_world_<warp_identifier> - The world name of the warp

unessentials_warp_position_x_<warp_identifier> - The X position of the warp
unessentials_warp_position_y_<warp_identifier> - The Y position of the warp
unessentials_warp_position_z_<warp_identifier> - The Z position of the warp
unessentials_warp_position_yaw_<warp_identifier> - The yaw position of the warp
unessentials_warp_position_pitch_<warp_identifier> - The pitch position of the warp

unessentials_warp_cancel_on_move_<warp_identifier> - "true" if 'cancel on move' setting is set to true, "false" otherwise
unessentials_warp_cancel_on_damage_<warp_identifier> - "true" if 'cancel on damage' setting is set to true, "false" otherwise
unessentials_warp_fade_enabled_<warp_identifier> - "true" if the fade is set to true, "false" otherwise

unessentials_warp_delay_<warp_identifier> - The default delay, in seconds before teleportation.
unessentials_warp_cooldown_<warp_identifier> - The default cooldown, in seconds between two teleportation.
unessentials_warp_player_delay_<warp_identifier> - The player's delay in seconds before teleportation.
unessentials_warp_player_cooldown_<warp_identifier> - The player's cooldown for this warp.
unessentials_warp_countdown_enabled_<warp_identifier> - "true" if the warp's countdown is enabled, "false" otherwise.

unessentials_warp_sound_enabled_<warp_identifier> - "true" if the warp's sound is enabled, "false" otherwise.
unessentials_warp_sound_type_<warp_identifier> - The warp's sound type UPPER_CASE Identifier.
unessentials_warp_sound_volume_<warp_identifier> - The warp's sound volume. value is between 0 and 1.
unessentials_warp_sound_pitch_<warp_identifier> - The warp's sound pitch. value is between 0 and 1.

unessentials_warp_bossbar_enabled_<warp_identifier> - "true" if the warp's bossbar is enabled, "false" otherwise.
unessentials_warp_bossbar_activation_<warp_identifier> - The warp's bossbar activation identifier.
unessentials_warp_bossbar_text_<warp_identifier> - The warp's bossbar text.
unessentials_warp_bossbar_type_<warp_identifier> - The warp's bossbar type.
unessentials_warp_bossbar_color_<warp_identifier> - The warp's bossbar color.

unessentials_warp_bossbar_enabled_<warp_identifier> - "true" if the warp's title is enabled, "false" otherwise.
unessentials_warp_bossbar_text_<warp_identifier> - The warp's title text.
unessentials_warp_bossbar_subtitle_<warp_identifier> - The warp's title subtitle text.

unessentials_warp_allowed_<warp_identifier> - "true" if the player is allowed to use this warp, "false" otherwise.
unessentials_warp_bossbar_subtitle_<warp_identifier> - The warp's use count. Start at 0.

7. Developpers API

See the Developper API's page for more informations.

8. Other useful informations

• The bossbar will always show as fully filled without changing before teleporting.
• The title will always display just after the teleportation.
• To enable or disable the module, you need to restart your server. Reloading the plugin will not change the module state.
• Please do not manually change the 'config-version' value in the module's config (same for other configuration files).