Skip to content

Configuration

Jarada edited this page Feb 7, 2021 · 13 revisions

config.yml

Waypoints:
  # Max number of home waypoints; must be 1 or more. To disable home waypoints, don't 
  # give players permission `wp.player`
  MAX_HOME_WAYPOINTS: 3

  # Max Length for Waypoint Names
  WP_NAME_MAX_LENGTH: 18

  # Max Length for Waypoint Descriptions
  WP_DESC_MAX_LENGTH: 100

  # The size of the waypoint menu, can be; compact, small, medium, large, max, resize
  MENU_SIZE: compact

  # Whether or not players can craft and use Waypoint Beacons
  ENABLE_BEACON: true

  # Whether players with permission `wp.beacon.unlimited` keep a beacon permanently in their 
  # inventory. When true, players will be given a beacon on join or respawn, cannot craft beacons 
  # and will always have a beacon in their inventory.
  BEACON_UNLIMITED_PERMANENT: false

  # The preferred inventory slot the plugin gifts the beacon into, if empty (otherwise, first empty 
  # slot is used instead). 0 = first empty, 1-9 = hotbar slots (left to right), 10-36 = inventory 
  # slots (left to right, top to bottom, as if reading a book)
  BEACON_UNLIMITED_PERMANENT_SLOT: 0

  # If beacon_unlimited_permanent is true, and a beacon is set in beacon_unlimited_permanent_slot to be 
  # given in a hotbar slot (1-9), then setting this flag to true will make it become immovable. Players
  # can then only move it into and out of the offhand slot. This keeps the beacon in the hotbar.
  BEACON_UNLIMITED_PERMANENT_IMMOVABLE: false
  
  # A whitelist of designated worlds to give a permanent beacon. If empty, it defaults to all worlds.
  BEACON_UNLIMITED_PERMANENT_WORLDS: []
  
  # Whether the plugin should handle respawning
  HANDLE_RESPAWNING: true

  # How the plugin should handle respawns; can be home (nearest home waypoint), bed (at a player's bed),
  # spawn (at the world's spawn point), or city (at the spawn point of the city world set in config)
  SPAWN_MODE: home

  # The world name to spawn a player to if Spawn Mode is set to city
  CITY_WORLD_NAME: world

  # Whether bed is included as a possible respawn point if Spawn Mode is set to home
  RESPAWN_INCLUDE_BED_IN_HOME_WAYPOINT_LIST: false

  # Whether to show discoverable waypoints in the menu, complete with assigned hint
  SHOW_DISCOVERABLE_WAYPOINTS: false

  # The icon to represent discoverable waypoints when shown in the menu
  SHOW_DISCOVERABLE_WAYPOINTS_ICON: LIGHT_GRAY_STAINED_GLASS_PANE
  
  # Whether accessing the Waypoint menu at a world's spawn point requires permission `wp.access.spawn`
  MENU_AT_SPAWN_REQUIRES_ACCESS: false

  # The effect to be assigned to warp travel, described below
  WARP_EFFECT: thunder

Warp Effect

Available options include:

  • blaze fire based transportation magic
  • bubble quiet bubbling effect
  • ender use the power of endermen
  • nether ghastly travelling magic
  • quiet when silence is due
  • thunder by the power of the god of thunder

Messages

Underneath the base config in config.yml there is a Messages section not shown here. Every bit of static text this plugin has is stored there for easy translation or to give a unique spin on your server.

Clone this wiki locally