# Supported Plugins

## **Vault**

Player Warps depends on [Vault](https://www.spigotmc.org/resources/34315/) so you can use any of your favorite economy/permissions plugins that will be used in Player Warps by hooking into Vault.

## **PlaceholderAPI**

Player Warps hooks into [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) so you can use the Player Warps placeholders everywhere that supports PlaceholderAPI. You can also use placeholders from PlaceHolderAPI anywhere in Player Warps. Here is a list of the current placeholders supported by Player Warps.

| Placeholder                                     | Description                                                                                                          |
| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| %pw\_player\_warps%                             | View the amount of your current warps.                                                                               |
| %pw\_player\_available%                         | View the amount of current warps a player can set.                                                                   |
| %pw\_player\_list\_\<lock/unlock>\_\<modifier>% | <p>View the warps in a list for that player.<br>Check the modifiers below.</p>                                       |
| %pw\_server\_list\_\<lock/unlock>\_\<modifier>% | <p>View the server warps in a list.<br>Check the modifiers below.</p>                                                |
| %pw\_player\_maxwarps%                          | View the maximum amount of warps that you can set.                                                                   |
| %pw\_server\_warps%                             | View the amount of current warps on the server.                                                                      |
| %pw\_visited\_warps%                            | View the amount of warps that have been visited.                                                                     |
| %pw\_visited\_warps\_percentage%                | View the percentage of warps that have been visited.                                                                 |
| %pw\_server\_warps\_\<category>%                | View the amount of current warps for that category.                                                                  |
| %pw\_warp\_name\_\<name>\_\<modifier>%          | <p>View the modifier of a specific warp.</p><p>Check modifiers below.</p>                                            |
| %pw\_warp\_pos\_\<position>\_\<modifier>%       | <p>View the modifier of a warp in that position of the warp list.</p><p>Check modifiers below.</p>                   |
| %pw\_warp\_sponsor\_\<id>\_\<modifier>%         | <p>View the modifier of a warp that is currently in that sponsor id.</p><p>Check modifiers below.</p>                |
| %pw\_gui\_warp\_\<modifier>%                    | <p>View the modifier of the current warp that is assigned to the player via a menu.</p><p>Check modifiers below.</p> |
| %pw\_gui\_category%                             | View the current category name that is assigned to the player via a menu.                                            |
| %pw\_gui\_category\_display%                    | View the current category display name that is assigned to the player via a menu.                                    |
| %pw\_gui\_page%                                 | View the current page that is assigned to the player via a menu.                                                     |
| %pw\_gui\_pages%                                | View the current pages that is assigned to the player via a menu.                                                    |

### Modifiers

Some placeholders do support modifiers, which allow you to grab information on a certain warp.

*Please remember, warp names may contain "\_" which will break any placeholder using a modifier. You need to make sure you adapt to this change by surrounding the warp names in <> For example %pw\_warp\_name\_\<test>\_owner% this is very important.*

| Modifier         | Description                                                                                                                                            |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| safe             | If the warp is safe or not.                                                                                                                            |
| owner            | Get the owner of the warp.                                                                                                                             |
| owner\_uuid      | Get the owner UUID of the warp.                                                                                                                        |
| warp             | Get the actual name of the warp.                                                                                                                       |
| warp\_display    | Get the display name of the warp.                                                                                                                      |
| id               | Get the ID of the warp                                                                                                                                 |
| favourite\_count | Get the favourite count for that warp.                                                                                                                 |
| location         | Get the location of the warp.                                                                                                                          |
| visits           | Get the visits of the warp                                                                                                                             |
| visits\_purged   | Get the amount of purged visits for that warp.                                                                                                         |
| my\_visits       | <p>Get the amount of visits the player has visited for that warp.</p><p><em>This will only work if you have the visited players menu enabled.</em></p> |
| has\_visited     | <p>If the player has visited the warp or not.</p><p><em>This will only work if you have the visited warps menu enabled.</em></p>                       |
| category         | Get the category of the warp.                                                                                                                          |
| rates\_all       | Get the total amount of rates for that warp.                                                                                                           |
| rates\_stars     | Get the average amount of rates represented as stars for that warp.                                                                                    |
| world            | Get the world of the warp.                                                                                                                             |
| world\_type      | Get the world type of the warp.                                                                                                                        |
| cost             | Get the teleport cost of the warp in a formatted way.                                                                                                  |
| cost\_raw        | Get the teleport cost of the warp that strips out all text.                                                                                            |
| cost\_set        | Get the set cost of the warp in a formatted way.                                                                                                       |
| cost\_set\_raw   | Get the set cost of the warp that strips out all text.                                                                                                 |
| server           | Get the server the warp is in.                                                                                                                         |
| sponsortime      | If the warp is sponsoring then it will show the amount of time left until the sponsor ends.                                                            |
| date             | Get the date the warp was created.                                                                                                                     |
| rent\_due        | Get the next rent due date for the warp.                                                                                                               |
| password         | Get the warp password.                                                                                                                                 |
| locked           | If the warp is locked or not in formatted text.                                                                                                        |
| locked\_raw      | If the warp is locked or not with no format.                                                                                                           |
| has\_password    | If the warp has a password or not.                                                                                                                     |
| paid             | Get the amount players paid for that warp.                                                                                                             |
| desc             | Get the description of the warp.                                                                                                                       |
| desc\_unwrapped  | Get the unwrapped description of the warp.                                                                                                             |

These are the current warp expansions, that hook into other plugins to change on how the plugin works. You can configure all these expansions and change how they work in the expansions.yml. Every expansion is configurable.

## BlueMap

Player Warps hooks into [BlueMap](https://www.spigotmc.org/resources/83557/) as an addon so you can view the warps on the server via the BlueMap web server interface. Here is the default configuration for this addon.

```yaml
  bluemap:
    # Do you want to enable bluemap support?
    # You need bluemap installed for this to work!
    enabled: false
    # What is the layer name?
    layer-name: "PlayerWarps"
```

## Dynmap

Player Warps hooks into [Dynmap](https://www.spigotmc.org/resources/274/) as an addon so you can view the warps on the server via the Dynmap web server interface. Here is the default configuration for this addon.

```yaml
  dynmap:
    # Do you want to enable dynmap support?
    # You need dynmap installed for this to work!
    enabled: false
    # What is the marker icon?
    marker-icon: star
    # What is the layer name?
    layer-name: "PlayerWarps"
    # What is the description of the marker?
    description:
      - "Owner: [owner]"
      - "Visits: [visits]"
      - "Description: [desc]"
      - "Time Created: [date]"
      - "Category: [category]"
      - "Rates: [rates]"
      - "Rates Average: [rates_average] ([rates_stars])"

```

## Pl3xMap

Player Warps hooks into [Pl3xMap](https://github.com/pl3xgaming/Pl3xMap) as an addon so you can view the warps on the server via the Pl3xMap web server interface. Here is the default configuration for this addon.

```yaml

pl3xmap:
  # Do you want to enable pl3xmap/squaremap support?
  # You need pl3xmap/squaremap installed for this to work!
  enabled: false
  # What is the layer name?
  layer-name: "PlayerWarps"
  # What is the tooltip for the marker?
  description:
    - "[warp]"
    - " "
    - "Owner: [owner]"
    - "Visits: [visits]"
    - "Description: [desc]"
    - "Time Created: [date]"
    - "Category: [category]"
    - "Rates: [rates]"
    - "Rates Average: [rates_average] ([rates_stars])"
  # What is the icon size?
  icon-size: 16
  # What is the anchor x?
  icon-x: 8
  # What is the anchor z?
  icon-z: 16
  # Should the layer be hidden by default?
  default-hidden: false
```

## ASkyBlock

Player Warps hooks into [ASkyBlock](https://www.spigotmc.org/resources/1220/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own islands. Here is the default configuration for this addon.

```yaml
  askyblock:
    # Do you want to enable askyblock support?
    # You need askyblock installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when an island is created?
    create: fals
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the island is deleted?
    delete: true
    # Should they only be able to set warps in islands? If disabled, they can set warps on their island or wilderness.
    only-land: true
    lang:
      not-in-island: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a island!"
      dont-own-island: "%prefix% &cSorry you can't set a warp here, because you don't own this island."
```

## BentoBox

Player Warps hooks into [BentoBox ](https://www.spigotmc.org/resources/73261/)as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own islands. Here is the default configuration for this addon.

```yaml
  bentobox:
    # Do you want to enable bentobox support?
    # You need bentobox installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when an island is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the island is deleted?
    delete: true
    # Should they only be able to set warps in islands? If disabled, they can set warps on their island or wilderness.
    only-land: true
    lang:
      not-in-island: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a island!"
      dont-own-island: "%prefix% &cSorry you can't set a warp here, because you don't own this island."
```

## FabledSkyBlock

Player Warps hooks into [FabledSkyBlock](https://songoda.com/marketplace/product/17) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own island. Here is the default configuration for this addon.

```yaml
  fabledskyblock:
    # Do you want to enable fabledskyblock support?
    # You need fabledskyblock installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when an island is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the island is deleted?
    delete: true
    # Should they only be able to set warps in islands? If disabled, they can set warps on their island or wilderness.
    only-land: true
    lang:
      not-in-island: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a island!"
      dont-own-island: "%prefix% &cSorry you can't set a warp here, because you don't own this island."
```

## IridiumSkyblock

Player Warps hooks into [IridiumSkyblock](https://www.spigotmc.org/resources/62480/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own island. Here is the default configuration for this addon.

```yaml
  iridiumskyblock:
    # Do you want to enable iridiumskyblock support?
    # You need iridiumskyblock installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when an island is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the island is deleted?
    delete: true
    # Should they only be able to set warps in islands? If disabled, they can set warps on their island or wilderness.
    only-land: true
    lang:
      not-in-island: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a island!"
      dont-own-island: "%prefix% &cSorry you can't set a warp here, because you don't own this island."
```

## Factions

Player Warps hooks into [Factions](https://www.spigotmc.org/resources/1900/) as an addon so players are restricted to create warps, manage warps and automatically delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  factions:
    # Do you want to enable factions support?
    # You need factions installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp get deleted once the faction is deleted?
    delete: true
    # Should they only be able to set warps in claims? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## FactionsUUID

Player Warps hooks into [FactionsUUID](https://www.spigotmc.org/resources/1035/) as an addon so players are restricted to create warps, manage warps and automatically delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  factionsuuid:
    # Do you want to enable factionsuuid support?
    # You need factionsuuid installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp get deleted once the faction is deleted?
    delete: true
    # Should they only be able to set warps in claims? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## SaberFactions

Player Warps hooks into [SaberFactions ](https://www.spigotmc.org/resources/69771/)as an addon so players are restricted to create warps, manage warps and automatically delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  saberfactions:
    # Do you want to enable saberfactions support?
    # You need saberfactions installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp get deleted once the faction is deleted?
    delete: true
    # Should they only be able to set warps in claims? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## FactionsX

Player Warps hooks into [FactionsX](https://www.spigotmc.org/resources/83459/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  factionsx:
    # Do you want to enable factionsx support?
    # You need factionsx installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp get deleted once the faction is deleted?
    delete: true
    # Should they only be able to set warps in claims? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## GriefPrevention

Player Warps hooks into [GriefPrevention](https://www.spigotmc.org/resources/1884/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  griefprevention:
    # Do you want to enable griefprevention support?
    # You need griefprevention installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a claim is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the claim is deleted?
    delete: true
    # Should they only be able to set warps in claim? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## GriefDefender

Player Warps hooks into [GriefDefender ](https://www.spigotmc.org/resources/68900/)as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  griefdefender:
    # Do you want to enable griefdefender support?
    # You need griefdefender installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a claim is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the claim is deleted?
    delete: true
    # Should they only be able to set warps in claim? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## Lands

Player Warps hooks into [Lands](https://www.spigotmc.org/resources/53313/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own land. Here is the default configuration for this addon.

```yaml
  lands:
    # Do you want to enable lands support?
    # You need lands installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a land is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp be created when a land spawn is set? (Only works if create is disabled)
    spawn-create: false
    # Should the warp get deleted once the land is deleted?
    delete: true
    # Should the warp get deleted once the land spawn is deleted? (Only works if spawn-create is enabled)
    spawn-delete: false
    # Should they only be able to set warps in lands? If disabled, they can set warps in their land or wilderness.
    only-land: true
    # Force PlayerWarps to allow warps to bypass land restrictions
    force: false
    lang:
      not-in-land: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a land"
      dont-own-land: "%prefix% &cSorry you can't set a warp here, because you don't own this land."
```

## LandLord

Player Warps hooks into [LandLord](https://www.spigotmc.org/resources/44398/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own land. Here is the default configuration for this addon.

```yaml
  landlord:
    # Do you want to enable landlord support?
    # You need landlord installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a land is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the land is deleted?
    delete: true
    # Should they only be able to set warps in lands? If disabled, they can set warps in their land or wilderness.
    only-land: true
    lang:
      not-in-land: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a land"
      dont-own-land: "%prefix% &cSorry you can't set a warp here, because you don't own this land."
```

## KingdomsX

Player Warps hooks into [KingdomsX](https://www.spigotmc.org/resources/77670/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own land. Here is the default configuration for this addon.

```yaml
  kindomsx:
    # Do you want to enable kingdomsx support?
    # You need kingdomsx installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a land is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the land is deleted?
    delete: true
    # Should they only be able to set warps in lands? If disabled, they can set warps in their land or wilderness.
    only-land: true
    lang:
      not-in-land: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a land"
      dont-own-land: "%prefix% &cSorry you can't set a warp here, because you don't own this land."
```

## Residence

Player Warps hooks into [Residence](https://www.spigotmc.org/resources/11480/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own land. Here is the default configuration for this addon.

```yaml
  residence:
    # Do you want to enable residence support?
    # You need Residence installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a land is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the land is deleted?
    delete: true
    # Should they only be able to set warps in lands? If disabled, they can set warps in their land or wilderness.
    only-land: true
    lang:
      not-in-land: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a land"
      dont-own-land: "%prefix% &cSorry you can't set a warp here, because you don't own this land."
      not-allowed-to-tp: "%prefix% &cSorry you can't teleport to this warp, &cYou don't have permission to teleport there."
```

## UltimateClaims

Player Warps hooks into [UltimateClaims](https://marketplace.songoda.com/marketplace/product/65) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  ultimateclaims:
    # Do you want to enable ultimateclaims support?
    # You need ultimateclaims installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a claim is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the claim is deleted?
    delete: true
    # Should they only be able to set warps in lands? If disabled, they can set warps in their land or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a claim"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## ClaimChunk

Player Warps hooks into [ClaimChunk](https://www.spigotmc.org/resources/44458/) as an addon so players are restricted to create warps and manage warps in their own claims. Here is the default configuration for this addon.

```yaml
  claimchunk:
    # Do you want to enable claimchunk support?
    # You need claimchunk installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a claim is created?
    # Should they only be able to set warps in lands? If disabled, they can set warps in their land or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a claim"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## CrashClaims

Player Warps hooks into [CrashClaims](https://www.spigotmc.org/resources/94017/) as an addon so players are restricted to create warps and manage warps in their own claims. Here is the default configuration for this addon.

```yaml
  crashclaims:
    # Do you want to enable crashclaims support?
    # You need crashclaims installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should they only be able to set warps in lands? If disabled, they can set warps in their land or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a claim"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## PlotSquared

Player Warps hooks into [PlotSquared](https://www.spigotmc.org/resources/1177/) as an addon so players are restricted to create warps, manage warps and automatically create/delete warps in their own plots. Here is the default configuration for this addon.

```yaml
  plotsquared:
    # Do you want to enable plotsquared support?
    # You need plotsquared installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a plot is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the plot is deleted?
    delete: true
    # Should they only be able to set warps in plots? If disabled, they can set warps in their plot or wilderness.
    only-land: true
    lang:
      not-in-plot: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a plot!"
      dont-own-plot: "%prefix% &cSorry you can't set a warp here, because you dont own this plot!"
```

## VirtualRealty

Player Warps hooks into [VirtualRealty](https://www.spigotmc.org/resources/95599/) as an addon so players are restricted to create warps, manage warps in their own plots. Here is the default configuration for this addon.

```yaml
  virtualrealty:
    # Do you want to enable virtualrealty support?
    # You need virtualrealty installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should trusted players (with place permissions) be treated like the owner of the claim?
    trusted-members: true
    # Should they only be able to set warps in claim? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-plot: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a plot!"
      dont-own-plot: "%prefix% &cSorry you can't set a warp here, because you don't own this plot."
```

## SimpleSkyBlock

Player Warps hooks into [SimpleSkyBlock](https://www.spigotmc.org/resources/72100/) as an addon so players are restricted to create warps and manage warps in their own islands. Here is the default configuration for this addon.

```yaml
  simpleskyblock:
    # Do you want to enable simpleskyblock support?
    # You need simpleskyblock installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should they only be able to set warps in islands? If disabled, they can set warps on their island or wilderness.
    only-land: true
    lang:
      not-in-island: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a island!"
      dont-own-island: "%prefix% &cSorry you can't set a warp here, because you don't own this island."
```

## SuperiorSkyBlock

Player Warps hooks into [SuperiorSkyBlock](https://bg-software.com/superiorskyblock/) as an addon so players are restricted to create warps, manage warps and automatically delete warps in their own islands. Here is the default configuration for this addon.

```yaml
  superiorskyblock:
    # Do you want to enable superiorskyblock support?
    # You need superiorskyblock installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a claim is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the faction is deleted?
    delete: true
    # Should they only be able to set warps in islands? If disabled, they can set warps on their island or wilderness.
    only-land: true
    lang:
      not-in-island: "%prefix% &cSorry you can't set a warp here, &cYou aren't on a island!"
      dont-own-island: "%prefix% &cSorry you can't set a warp here, because you don't own this island."
      island-banned: "%prefix% &cSorry you can't teleport here, because you're banned from this island!"
      island-locked: "%prefix% &cSorry you can't teleport here, because this island is locked!"
```

## Towny

Player Warps hooks into [Towny](https://www.spigotmc.org/resources/72694/) as an addon so players are restricted to create warps and manage warps in their own towns. Here is the default configuration for this addon.

```yaml
  towny:
    # Do you want to enable towny support?
    # You need towny installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should town residents be treated like the owner of the town?
    town-residents: true
    # Should the warp get deleted once the town is deleted?
    delete: true
    # Should they only be able to set warps in towns? If disabled, they can set warps in their town or wilderness.
    only-land: true
    # Should the plugin cancel the warp teleportation if the warp they're teleporting to is enemey land?
    cancel-enemy-teleport: false
    # Should the plugin only allow warp teleportation if the player is a member of the town?
    # Please note that if this is enabled, the above setting will be ignored.
    only-town-members-teleport: false
    # Block players from teleporting to warps in outlaw towns.
    block-outlaw-teleport: false
    # Should the plugin mark the warp as unsafe if its in pvp land?
    mark-warp-unsafe-if-pvp: true
    lang:
      not-in-town: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a town!"
      dont-own-town: "%prefix% &cSorry you can't set a warp here, because you don't own this town."
      town-teleport-enemy: "%prefix% &cSorry you can't teleport to this warp as its in enemy land."
      town-not-member: "%prefix% &cSorry you can't teleport to this warp as you're not a member of this town."
      town-outlaw: "%prefix% &cSorry you can't teleport to this warp as its in an outlaw town."
```

## HuskTowns

Player Warps hooks into [HuskTowns](https://www.spigotmc.org/resources/92672/) as an addon so players are restricted to create warps, manage warps and automatically delete warps in their own towns. Here is the default configuration for this addon.

```yaml
  husktowns:
    # Do you want to enable husktowns support?
    # You need husktowns installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should the warp be created when a town is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the town is deleted?
    delete: true
    # Should they only be able to set warps in towns? If disabled, they can set warps in their town or wilderness.
    only-land: true
    # What is the required level for a town to set a warp?
    required-level: 0
    lang:
      not-in-town: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a town!"
      dont-own-town: "%prefix% &cSorry you can't set a warp here, because you don't own this town."
      not-required-level: "%prefix% &cSorry your town doesn't meet the level requirements"
```

## HuskClaims

Player Warps hooks into [HuskClaims](https://www.spigotmc.org/resources/92672/) as an addon so players are restricted to create warps, manage warps and automatically delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  huskclaims:
    # Do you want to enable huskclaims support?
    # You need huskclaims installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should trusted members be treated like the owner of the town?
    trusted-members: true
    # Should the warp be created when a town is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the town is deleted?
    delete: true
    # Should they only be able to set warps in towns? If disabled, they can set warps in their town or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## uxmClaims

Player Warps hooks into [uxmClaims](https://builtbybit.com/resources/86890/) as an addon so players are restricted to create warps, manage warps and automatically delete warps in their own claims. Here is the default configuration for this addon.

```yaml
  uxmclaims:
    # Do you want to enable uxmclaims support?
    # You need uxmclaims installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Should trusted members be treated like the owner of the claim?
    trusted-members: true
    # Should the warp be created when a claim is created?
    create: false
    # What should the warp name be called when its created? Only as of right now you can use %player%
    warp-name-creation: "%player%"
    # Should the warp get deleted once the claim is deleted?
    delete: true
    # Should they only be able to set warps in claim? If disabled, they can set warps in their claim or wilderness.
    only-land: true
    lang:
      not-in-claim: "%prefix% &cSorry you can't set a warp here, &cYou aren't in a claim!"
      dont-own-claim: "%prefix% &cSorry you can't set a warp here, because you don't own this claim."
```

## WorldGuard

Player Warps hooks into [WorldGuard](https://dev.bukkit.org/projects/worldguard) as an addon so players are restricted to create warps in regions. Here is the default configuration for this addon.

```yaml
  worldguard:
    # Do you want to enable worldguard support?
    # You need worldguard installed for this to work!
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # Do you want to revert the addon to make players force to be in a region? If so the message below will be displayed as not being in a region.
    revert: false
    # When reverted, do players need to be a member/owner of the region?
    owner-member: false
    # Should the warp get deleted once the region is deleted?
    # Due to limitations of WorldGuard, this setting will only work if you have ProtectionStones enabled on your server.
    delete: false
    lang:
      in-region: "%prefix% &cSorry you can't set a warp here, because you are in a region!"
      dont-own-region: "%prefix% &cSorry you can't set a warp here, because you dont own this region!"
```

## Essentials

Player Warps hooks into [Essentials](https://www.spigotmc.org/resources/9089/) as an expansion so players previous locations are remembered when teleporting to a warp. Here is the default configuration for this addon.

```yaml
  essentials:
    # Do you want to enable essentials expansion?
    # This expansion sets their last location before they teleport to a warp.
    # You need Essentials installed for this to work!
    enabled: true
    # What version of this expansion do you want to download/use?
    version: latest
```

## HuskHomes

Player Warps hooks into [HuskHomes](https://www.spigotmc.org/resources/83767/) as an expansion so players previous locations are remembered when teleporting to a warp. Here is the default configuration for this addon.

```yaml
  huskhomes:
    # Do you want to enable huskhomes expansion?
    # This expansion sets their last location before they teleport to a warp.
    # You need HuskHomes installed for this to work!
    enabled: true
    # What version of this expansion do you want to download/use?
    version: latest
```

## TokenManager

Player Warps hooks into [TokenManager](https://www.spigotmc.org/resources/8610/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  tokenmanager:
    # Do you want to enable the TokenManager currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The prefix of the price variable, this is how you want the variable to show when using the token manager currency.
    prefix: "%price% tokens"
```

## PlayerPoints

Player Warps hooks into [PlayerPoints](https://www.spigotmc.org/resources/80745/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  playerpoints:
    # Do you want to enable the PlayerPoints currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The prefix of the price variable, this is how you want the variable to show when using the player points currency.
    prefix: "%price% points"
```

## BeastToken

Player Warps hooks into [BeastToken](https://www.spigotmc.org/resources/20806/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  beasttoken:
    # Do you want to enable the BeastToken currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The prefix of the price variable, this is how you want the variable to show when using the beast token currency.
    prefix: "%price% tokens"
```

## GemsEconomy

Player Warps hooks into [GemsEconomy](https://www.spigotmc.org/resources/95658/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  gemseconomy:
    # Do you want to enable the GemsEconomy currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The prefix of the price variable, this is how you want the variable to show when using the gemseconomy currency.
    prefixes:
      currency_name: "%price% gems"
```

## UltraEconomy

Player Warps hooks into [UltraEconomy](https://www.spigotmc.org/resources/83374/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  ultraeconomy:
    # Do you want to enable the UltraEconomy currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in-game to decide what currency to use.
    name: "gems"
    # The prefix of the price variable, this is how you want the variable to show when using the ultraeconomy currency.
    prefixes:
      currency_name: "%price% coins"
```

## EcoBits

Player Warps hooks into [EcoBits](https://www.spigotmc.org/resources/109967/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  ecobits:
    # Do you want to enable the EcoBits currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The prefix of the price variable, this is how you want the variable to show when using the eco bits currency.
    prefixes:
      currency_name: "%price% coins"
```

## ExcellentEconomy

Player Warps hooks into [ExcellentEconomy](https://www.spigotmc.org/resources/84121/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  excellenteconomy:
    # Do you want to enable the ExcellentEconomy currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The prefix of the price variable, this is how you want the variable to show when using the excellent economy currency.
    prefixes:
      currency_name: "%price% coins"
```

## RivalCredits

Player Warps hooks into [RivalCredits](https://builtbybit.com/resources/31250/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  rivalcredits:
    # Do you want to enable the RivalCredits currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The prefix of the price variable, this is how you want the variable to show when using the rival credits currency.
    prefix: "%price% credits"
```

## RivalHarvesterHoes

Player Warps hooks into [RivalHarvesterHoes](https://builtbybit.com/resources/21424/) as a currency so you can teleport/set/rent/rename/reset warps using this currency. Here is the default configuration for this addon.

```yaml
  rivalharvesterhoes:
    # Do you want to enable the RivalHarvesterHoes currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The prefix of the price variable, this is how you want the variable to show when using the rival harvester hoes currency.
    prefix: "%price% credits"
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.olziedev.com/projects/playerwarps/plugins.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
