Skip to content

Warps#

Warps enables players to add a personal warp signs to their island.

Created and maintained by tastybento.

Useful links

Installation#

  1. Place the Warps addon jar in the addons folder of the BentoBox plugin
  2. Restart the server
  3. The addon will create a data folder and inside the folder will be a config.yml
  4. Edit the config.yml how you want.
  5. Restart the server if you make a change

Configuration#

config.yml#

After addon is successfully installed, it will create config.yml file. Every option in this file comes with comments about them. Please check file for more information. You can find the latest config file: config.yml

What is warp restriction?

This limits warp sign creation to players who have at least a certain level of island. It requires the Level addon and the default level is 10.

What is welcome text

This is the text that player must put on sign to make it a warp sign, e.g., [Welcome]. It is not case sensitive!

This text must be in the top line.

What is disabled GameModes?

This list stores GameModes in which Warps addon should not work.

To disable addon it is necessary to write its name in new line that starts with -. Example: 

  disabled-gamemodes:
   - BSkyBlock

What is lore format?

Lore format allows changing default color for description lines in sign. Description lines are used in GUI.

Description lines contains sign lines that are bellow [welcome] text.

What is doing allow in other worlds?

This enables warp signs to be placed in any world, even non-BentoBox worlds.

Players must have the welcomewarpsigns.warp permission to use.

What is show-warps-on-map?

When set to true, warp sign locations are shown as markers on web map plugins (Dynmap, BlueMap).

Requires a compatible map plugin and the BentoBox map hook to be active. Each warp sign appears as a point marker with the text from the sign lines below [Welcome].

Default: true

What is warp and warps?

The command warp requires <player> to which warp should happen, while warps opens menu that allows to choose a player.

If you have enabled allow in other worlds then it will be as a main command /warp

While for each BentoBox GameMode it still will be /[player_cmd] warp

Customizable GUI's#

BentoBox 1.17 API introduced a function that allows to implement customizable GUI's. This addon is one of the first one which uses this functionality. We tried to be as simple as possible for customization, however, some features requires explanation. You can find more information how BentoBox custom GUI's works here: Custom GUI's

How can I customize GUI's

To customize Addon GUI's you need to have version 1.12. This is a first version that has implemented them. Addon will create a new directory under /plugins/BentoBox/addons/Warps with a name panels

What does PREVIOUS|NEXT button type?

The PREVIOUS and NEXT button types allows creating automatic paging, when you have more islands than spaces in GUI. These types have extra parameters under data:

  • indexing - indicates if button will show page number.

Example: 

    icon: tipped_arrow[potion_contents={custom_color:11546150}]
    title: warps.gui.buttons.previous.name
    description: warps.gui.buttons.previous.description
    data:
      type: PREVIOUS
      indexing: true
    action:
      left:
        action: PREVIOUS
        tooltip: warps.gui.tips.click-to-previous

What is RANDOM button type?

This button allows players teleporting to a random warp. It is available only if there are more than 1 warp.

Example: 

    icon: DROPPER
    title: warps.gui.buttons.random.name
    description: warps.gui.buttons.random.description
    data:
      type: RANDOM
    actions:
      warp:
        click-type: left
        tooltip: warps.gui.tips.click-to-warp

What is WARP button type?

The WARP button creates a dynamic entry for a warp object.

Specifying title, description and icon will overwrite dynammic generation based on sign and database data. By default these values will be generated from database entries.

Icon PLAYER_HEAD will be replaced with owner player head. However, currently there is no option to specify differnet player head.

Example: 

    warp_button:
      icon: PLAYER_HEAD
      title: warps.gui.buttons.warp.name
      description: warps.gui.buttons.warp.description
      data:
        type: WARP
      actions:
        warp:
          click-type: left
          tooltip: warps.gui.tips.click-to-warp

Commands#

Tip

[player_command] is command that differ depending on the gamemode you are running. The Gamemodes' config.yml file contains options that allows you to modify these values. As an example, on BSkyBlock, the default [player_command] is island. Be aware, that this addon allows changing player commands aliases in addon config.yml file.

  • /[player_command] warp <player>: warps player to targeted sign.
  • /[player_command] warps: opens GUI that allows to view all available warp signs.

Permissions#

Tip

[gamemode] is a prefix that differs depending on the gamemode you are running. The prefix is the lowercased name of the gamemode, i.e. if you are using BSkyBlock, the prefix is bskyblock. Similarly, if you are using AcidIsland, the prefix is acidisland.

  • [gamemode].island.warp - Player can use /[player_command] warp and /[player_command] warps commands. Enabled by default.
  • [gamemode].island.addwarp - Players can create warp signs. Enabled by default.
  • welcomewarpsigns.warp - Player can use /warp and /warps commands. Disabled by default. Requires allow-in-other-worlds.
  • welcomewarpsigns.addwarp - Players can create warp signs. Disabled by default. Requires allow-in-other-worlds.
Something is missing?

You can find the comprehensive list of permissions in the addon.yml file of this addon.
If something is indeed missing from the list below, please let us know!

FAQ#

Can you add a feature X?

Please add it to the list here.

I have a bug, where should I report it?

Please add it to the list here.

Changelog#

What's new in v1.18.0

Released: 2026-04-05

  • Web map support (Dynmap / BlueMap). Warp signs now show as point markers on web maps when the show-warps-on-map option is enabled (default: true). Requires a BentoBox-compatible map plugin.
  • ⚙️ New show-warps-on-map config option (see Configuration above).
  • 🔡 Russian locale updated to MiniMessage format with full key coverage.
  • Additional locale files added and updated to match BentoBox formatting.
  • Requires BentoBox API 3.12.0+.

🔡 Delete BentoBox/addons/Warps/locales/ to regenerate locale files with the new format.

Release v1.18.0

What's new in v1.19.0 — locale migration required

Released: 2026-04-11

  • All locale files migrated to MiniMessage. Every locale file has been converted from legacy & color codes to MiniMessage tags for consistency with BentoBox 3.14.
  • Requires BentoBox API 3.14.0+.
  • Warps now builds against Paper 1.21.11 exclusively (Spigot API dropped).

🔺 BentoBox 3.14.0 required. Ensure your BentoBox is updated before upgrading Warps.

🔡 Regenerate locale files — delete BentoBox/locales/Warps/ and restart the server. Any & color codes in custom locale files will no longer render.

Release v1.19.0

Translations#

Help us keep translations accurate

Most BentoBox and addon translations are now generated with the help of AI, so the bulk of the work is already done — but AI is not perfect. What we really need from the community is error reports and corrections.

  • Spotted a mistake or awkward phrasing? Open an issue or a PR on the relevant repository at bentobox.world (a short link to our GitHub org), or tell us on Discord.
  • Want to add a brand-new language? Open a PR adding a new locale file to src/main/resources/locales/ in the relevant repo, or ask on Discord and we'll get you started.
Language Language code Progress
English (United States) en-US 100% (Default)
Chinese, China zh-CN 100%
Chinese, Hong Kong zh-HK 100%
Chinese, Taiwan zh-TW 100%
Croatian hr 100%
Czech cs 100%
Dutch nl 100%
French fr 100%
German de 100%
Hungarian hu 100%
Indonesian id 100%
Italian it 100%
Japanese ja 100%
Korean ko 100%
Latvian lv 100%
Polish pl 100%
Portuguese pt 100%
Portuguese, Brazil pt-BR 100%
Romanian ro 100%
Russian ru 100%
Spanish es 100%
Turkish tr 100%
Ukrainian uk 100%
Vietnamese vi 100%

Api#

Events#

Since BentoBox 1.17 API implemented a feature that solved an issue with classloaders. Plugins that wants to use events directly, now can do it.

You just need to add Visit to your project as dependency. You can use Maven for that:

<dependency>
    <groupId>world.bentobox</groupId>
    <artifactId>warps</artifactId>
    <version>1.11.2</version>
    <scope>provided</scope>
</dependency>

Description

Event that is triggered after player created a new warp sign.

Link to the class: WarpInitiateEvent

Variables

  • UUID player - id of the player who creates warp sign.
  • Location warpLoc - the location of warp sign.

Code example

@EventHandler(priority = EventPriority.MONITOR)
public void onWarpInitiate(WarpInitiateEvent event) {
    UUID player = event.getPlayer();
    Location warpLoc = event.getWarpLoc();
}

Description

Event that is triggered after player created a new warp sign.

Link to the class: WarpRemoveEvent

Variables

  • UUID owner - id of the player who owns warp sign.
  • UUID remover - id of the player who removes warp sign.
  • Location warpLoc - the location of warp sign.

Code example

@EventHandler(priority = EventPriority.MONITOR)
public void onWarpRemove(WarpRemoveEvent event) {
    UUID owner = event.getOwner();
    UUID remover = event.getRemover();
    Location warpLoc = event.getWarpLocation();
}
Last update: April 13, 2026 06:55:10