Pages » Sunlight » Modules » Warps


Commands

Command Aliases Description Player only Permission(s)
/warp [id]
/warp [id] [player]
/warp editor
/warps Teleport on specified warp.
Teleport player to specified warp.
Open warp editor.
Yes
No
Yes
sunlight.warps.cmd.warp
sunlight.warps.cmd.warp.others
sunlight.warps.cmd.warp.editor
/setwarp [id] - Set warp. Yes sunlight.warps.cmd.setwarp
/delwarp [id] - Delete warp. No sunlight.warps.cmd.delwarp
sunlight.warps.cmd.delwarp.others


Permissions

Permission Description
sunlight.warps.warp.[id] Allows to teleport on warp with specified id.
sunlight.warps.bypass.cost Bypasses warp teleport cost.

Config

general:
  # When false disables warps GUI and warp list will be shown in chat.
  use-gui: true
  # When false disables user warps and main gui. All existent user warps won't be loaded.
  user-warps-enabled: true
  # List of worlds, where warps can not be created.
  world-blacklist:
  - events
  - spawn
  # Amount of possible warps depends on player rank.
  # You can use default for all ranks not listed here.
  # When player have multiple ranks, the most greater (or first negative one) will be selected.
  # Negative values = Unlimited.
  warps-by-rank:
    VIP: 2
    Gold: 3

# Warp editor settings.
# These settings are effective only for non-admin players.
editor:
  description:
    # Min. warp lore line length, and max. amount of warp lore lines.
    line-length: 50
    max-lines: 5

# Warps GUI.
gui:
  # Main GUI with warp categories (User and Server warps).
  main:
    # GUI title and size.
    title: Warps
    size: 27
    
    # Your custom items here.
    # Placeholders:
    # - %user-amount% - Amount of player warps.
    # - %server-amount% - Amount of server warps.
    content:
      player-warps:
        material: PLAYER_HEAD
        name: '&aPlayer Warps'
        lore:
        - '&eTotal warps: &6%user-amount%'
        skull-hash: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjk5NjgyNGY3MjhkYzc4OTZkYWZlNGViOGExMzlhOGU4NGQ1ZjU0MWEyMjE2NGQ1NWNkYTc0ZTE4OWEzNDYxNiJ9fX0=
        slots: 11
        type: OPEN_PLAYER_WARPS
      server-warps:
        material: COMPASS
        name: '&bServer Warps'
        lore:
        - '&7Total warps: &f%server-amount%'
        slots: 15
        type: OPEN_SERVER_WARPS
  
  # GUI with player warps.
  player-warps:
    title: Player Warps
    size: 54
    
    # Defines the warp slots in GUI.
    warp-slots: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44
    # Lore for warp icons.
    # Placeholders:
    # - %owner% - Warp owner name.
    # - %id% - Warp id.
    # - %lore% - Warp lore/description.
    warp-lore:
    - '&eOwner: &6%owner%'
    - '&eWarp ID: &6%id%'
    - '&7'
    - '%lore%'
    - '&7'
    - '&aLeft Click &eto teleport'
    - '&aRight Click &eto edit &c(owner only)'
    
    content:
      filler_1:
        material: YELLOW_STAINED_GLASS_PANE
        name: '&7'
        lore: []
        slots: 45,46,47,51,52,53
      filler_2:
        material: ORANGE_STAINED_GLASS_PANE
        name: '&7'
        lore: []
        slots: 48,50
      return:
        material: REDSTONE
        name: '&cReturn'
        lore: []
        slots: 49
        type: RETURN
      next:
        material: ARROW
        name: '&aNext Page'
        slots: 53
        type: NEXT
      back:
        material: ARROW
        name: '&cPrevious Page'
        slots: 45
        type: BACK
  
  # GUI with server warps.
  server-warps:
    title: Server Warps
    size: 54
    
    warp-slots: 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44
    # Lore for warp icons.
    # Placeholders:
    # - %owner% - Warp owner name.
    # - %id% - Warp id.
    # - %lore% - Warp lore/description.
    # - %cost% - Teleport cost.
    warp-lore:
    - '&eOwner: &6%owner%'
    - '&eTeleport Cost: &6%cost%'
    - '&eAccess: &6%access%'
    - '&eWarp ID: &6%id%'
    - '&7'
    - '%lore%'
    - '&7'
    - '&aLeft Click &eto teleport'
    - '&aRight Click &eto edit &c(owner only)'
    
    content:
      filler_1:
        material: YELLOW_STAINED_GLASS_PANE
        name: '&7'
        lore: []
        slots: 45,46,47,51,52,53
      filler_2:
        material: ORANGE_STAINED_GLASS_PANE
        name: '&7'
        lore: []
        slots: 48,50
      return:
        material: REDSTONE
        name: '&cReturn'
        lore: []
        slots: 49
        type: RETURN
      next:
        material: ARROW
        name: '&aNext Page'
        slots: 53
        type: NEXT
      back:
        material: ARROW
        name: '&cPrevious Page'
        slots: 45
        type: BACK
18+