Sueta

BeaconWaypoints

1.7.2

Use beacons as fast travel points

·Plugin

Beacon Waypoints
This plugin gives beacons extra functionality by letting players use beacons to fast travel between them! Install this plugin by putting the jar file into your plugins folder and starting/restarting the server.

Supports versions 1.14-1.20.4

This plugin uses bStats.

Features

  • Create public or private waypoints at beacons
  • Configurable icon chooser for waypoints
  • Discovery Mode: Players can discover public waypoints by interacting with the beacon and can only teleport between discovered waypoints
  • Various payment options for teleportation
  • language.yml file for custom translations

Commands

  • /waypoint <name> <public | private> - Create a public or private waypoint for the beacon the player is standing on
  • /waypoints reload - Reloads the config

Demo
YouTube

Note: Teleportation between beacons requires the beacon's beam to have no blocks inside it, including transparent blocks like glass. Bedrock is an exception, so this plugin will work in the Nether.

Permissions

  • BeaconWaypoints.createWaypoints: Allows players to create waypoints
  • BeaconWaypoints.useWaypoints: Allows players to use waypoints
  • BeaconWaypoints.usePrivateWaypoints: Allows players to create and teleport to private waypoints
  • BeaconWaypoints.breakWaypointBeacons: Allows players to break beacons that have waypoints
  • BeaconWaypoints.manageAllWaypoints: Allows players to edit, pin, or remove all public waypoints and corresponding beacons
  • BeaconWaypoints.reload: Allows players to reload the config

Configuration

  • max-public-waypoints: The maximum amount of public waypoints that can exist at once on the server (default: 100)
  • max-private-waypoints: The maximum amount of private waypoints that each player can have (default: 30)
  • force-alphanumeric-names: Force waypoint names to be alphanumeric when they are created (default: false)
  • public-waypoint-menu-rows: The number of rows the public waypoint selection menu will show per page, not including the row for page navigation (default: 3, range: 1-5)
  • private-waypoint-menu-rows: The number of rows the private waypoint selection menu will show per page, not including the row for page navigation (default: 2, range: 1-5)
  • instant-teleport: Activate teleportation as soon as the destination is chosen without a warmup animation (default: false)
  • disable-animations: Disable the particle animations when teleporting through a beacon (default: false)
  • launch-player: Launch the player when teleporting through a beacon (default: true)
  • launch-player-height: The y-level players will launch into the air before teleporting to the destination. Anti-cheat plugins may not allow players to go above a certain height, so adjust this as needed. The minimum value is the world height. (default: 576)
  • disable-group-teleporting: By default, beacons teleport anyone standing on top of them. If you want to limit the teleportation to only the player who chooses the destination, set this to true. (default: false)
  • allow-beacon-break-by-owner: If the BeaconWaypoints.breakWaypointBeacons permission is disabled for a player, this will still allow them to break a beacon if all waypoints attached to it are owned by them. The owner of a beacon is the player who placed it. (default: true)
  • payment-mode: none, xp, or money (default: none)
  • xp-cost-per-chunk: The cost per chunk between two waypoints using the XP payment mode (default: 0)
  • xp-cost-dimension: The cost to teleport between dimensions using the XP payment mode (default: 0)
  • money-cost-per-chunk: The cost per chunk between two waypoints using the money payment mode (default: 0)
  • money-cost-dimension: The cost to teleport between dimensions using the money payment mode (default: 0)
  • cost-multiplier: A multiplier that affects the cost based on distance. The formula used is cost*(distance^multiplier) (default: 0)
  • required-items: a list of items with different properties regarding payment (default: empty)
  • banned-items: a list of items that will not allow players to teleport if they are in their inventory (default: empty)
  • discover-mode: Enable discovery mode which only allows players to teleport to waypoints they have discovered by interacting with their beacon (default: false)
  • allow-all-worlds: Allow waypoints to be created in any world (default: true)
  • allowed-worlds: List of worlds that allow waypoints based on folder name (default: world, world_nether, world_the_end)
  • waypoint-icons: List of items that can be used for waypoint icons, the order given here is the same order that will be in the icon picker menu (default includes 111 items)
Default Config File
#
# CONFIGURATION FOR BEACON WAYPOINTS
#

# The maximum amount of public waypoints that can exist at once on the server
max-public-waypoints: 100

# The maximum amount of private waypoints that each player can have
max-private-waypoints: 30

# Force waypoint names to be alphanumeric when they are created
force-alphanumeric-names: false

# The number of rows the public waypoint selection menu will show per page, not including the row for page navigation
# Range: 1-5
public-waypoint-menu-rows: 3

# The number of rows the private waypoint selection menu will show per page, not including the row for page navigation
# Range: 1-5
private-waypoint-menu-rows: 2

# Activate teleportation as soon as the destination is chosen without a warmup animation
instant-teleport: false

# Disable the particle animations when teleporting through a beacon
disable-animations: false

# Launch the player into the air when teleporting through a beacon
launch-player: true

# The y-level players will launch into the air before teleporting to the destination. Anti-cheat plugins may not allow
# players to go above a certain height, so adjust this as needed. The minimum value is the world height.
launch-player-height: 576

# By default, beacons teleport anyone standing on top of them. If you want to limit the teleportation to only the
# player who chooses the destination, set this to true.
disable-group-teleporting: false

# If the BeaconWaypoints.breakWaypointBeacons permission is disabled for a player, this will still allow them to break
# a beacon if all waypoints attached to it are owned by them. The owner of a beacon is the player who placed it.
allow-beacon-break-by-owner: true

# If you want to have players pay to teleport, you can change it here.
# The cost to teleport is determined by the amounts given here multiplied by the distance between the beacons in chunks.
# The value for each is only used when that mode is specified.
# If you want the cost to be the same at any distance, then set that value below
# and set cost-multiplier to 0.
# If a player is teleporting between dimensions, it will charge the dimension price.
# Money mode uses the currency from the EssentialsX plugin
# Modes: none, xp, money
payment-mode: none

xp-cost-per-chunk: 0
xp-cost-dimension: 0

money-cost-per-chunk: 0
money-cost-dimension: 0

# This value changes the cost of travel based on distance.
# The formula used is cost*(distance^multiplier), and the multiplier must be at least 0
# 0: constant cost for any distance
# Between 0 and 1: cost increases slower with distance
# 1: cost increases linearly
# Above 1: cost increases faster with distance
# This does not affect the price of teleporting between dimensions.
cost-multiplier: 0

# Require players to have a specific item with a specific name to teleport.
# If the item does not need a specific name (ex. custom items), then remove the "name" field.
# The amount of the item the player needs in their inventory can be set with the "amount" field.
# The amount of the item the player needs in their inventory to travel between dimensions can be set with the "amount-dimension" field.
# If you do not want the cost multiplier to affect item amounts needed, set "use-multiplier" to false.
# This could be useful if you require a certain amount of an item but also want an XP payment based on distance.
# You can set the item(s) to be consumed or let the player keep it with the "consume" field (ex. teleport spell item)
#
# Example for requiring either an ender pearl that is consumed and uses the cost multiplier
# or a gold nugget named "Teleport Token" with gold text that is not consumed and does not use the cost multiplier:
#
# required-items:
#   - item: ENDER_PEARL
#     amount: 1
#     dimension-amount: 10
#     use-multiplier: true
#     consume: true
#   - item: GOLD_NUGGET
#     name: §6Teleport Token
#     amount: 1
#     use-multiplier: false
#     consume: false
required-items:

# Prevent players from teleporting if they have certain items in their inventory
# Example:
# banned-items:
#   - SHULKER_BOX
#   - TNT
banned-items:

# Discovery mode will only show public waypoints that have been "discovered" by the player.
# A player discovers a waypoint by interacting with the beacon associated with it
discovery-mode: false

# Allow waypoints to be created in any world
allow-all-worlds: true

# List of worlds that allow waypoints if allow-all-worlds is disabled (based on folder name)
allowed-worlds:
  - world
  - world_nether
  - world_the_end

# List of items that can be used for waypoint icons
# The order given here is the same order that will be in the icon picker menu
waypoint-icons:
  - APPLE
  - SHROOMLIGHT
  - TOTEM_OF_UNDYING
  - EMERALD
  - DIAMOND
  - END_CRYSTAL
  - LEATHER
  - FILLED_MAP
  - SNOW_BLOCK
  - RED_MUSHROOM
  - CARROT
  - GOLDEN_APPLE
  - CREEPER_HEAD
  - PRISMARINE_BRICKS
  - ALLIUM
  - IRON_PICKAXE
  - QUARTZ_BRICKS
  - SKELETON_SKULL
  - POPPY
  - PUMPKIN
  - HONEYCOMB
  - SEA_LANTERN
  - BLUE_ICE
  - PURPUR_BLOCK
  - ENCHANTING_TABLE
  - OAK_LOG
  - WHEAT
  - RED_BED
  - ORANGE_TULIP
  - BLAZE_POWDER
  - SUGAR_CANE
  - LAPIS_LAZULI
  - CHORUS_FRUIT
  - END_PORTAL_FRAME
  - ELYTRA
  - BREWING_STAND
  - REDSTONE
  - RED_SAND
  - END_STONE
  - CACTUS
  - WATER_BUCKET
  - SHULKER_BOX
  - CHEST
  - NETHERITE_INGOT
  - SOUL_SAND
  - RED_NETHER_BRICKS
  - MAGMA_BLOCK
  - SAND
  - ENDER_PEARL
  - WARPED_STEM
  - CRIMSON_STEM
  - ZOMBIE_HEAD
  - OBSIDIAN
  - WITHER_SKELETON_SKULL
  - GRASS_BLOCK
  - IRON_BLOCK
  - COPPER_BLOCK
  - GOLD_BLOCK
  - DIAMOND_BLOCK
  - NETHERITE_BLOCK
  - SPRUCE_LOG
  - BIRCH_LOG
  - JUNGLE_LOG
  - ACACIA_LOG
  - DARK_OAK_LOG
  - SPONGE
  - BOOKSHELF
  - NETHERRACK
  - GLOWSTONE
  - STONE_BRICKS
  - DEEPSLATE_BRICKS
  - MELON
  - MYCELIUM
  - EMERALD_BLOCK
  - HAY_BLOCK
  - BAMBOO
  - IRON_BARS
  - DRAGON_HEAD
  - CAMPFIRE
  - BEE_NEST
  - TNT
  - BEACON
  - QUARTZ
  - IRON_INGOT
  - COPPER_INGOT
  - GOLD_INGOT
  - STRING
  - FEATHER
  - GUNPOWDER
  - WHEAT_SEEDS
  - BRICK
  - BOOK
  - SLIME_BALL
  - EGG
  - BONE
  - BLAZE_ROD
  - GOLD_NUGGET
  - NETHER_WART
  - ENDER_EYE
  - EXPERIENCE_BOTTLE
  - NETHER_STAR
  - FIREWORK_ROCKET
  - MUSIC_DISC_STAL
  - CAKE
  - SWEET_BERRIES
  - WHITE_WOOL
  - GOLDEN_PICKAXE
  - DIAMOND_PICKAXE
  - NETHERITE_PICKAXE
  - FISHING_ROD
  - TRIDENT
  - GOLDEN_CARROT
Default language.yml
already-exists-at-location: A waypoint already exists at that location
back: Back
beacon-obstructed: The destination beacon is not able to be traveled to. It either is not constructed correctly, or something is obstructing the beam.
blocks: blocks
cancel: Cancel
cannot-check-for-update: Unable to check for updates
cannot-save-default-language-config: Could not save default language config!
config-reloaded: BeaconWaypoints config reloaded!
confirm-delete: Confirm Delete
change-beacon-effect: Change beacon effect
change-icon: Change Icon
click-to-download: Click here to download
cost: Cost
created-private-waypoint: Created the private waypoint
created-public-waypoint: Created the public waypoint
current-version: Current version
delete-waypoint: Delete Waypoint
discovered-waypoint: Discovered waypoint
distance: Distance
download-link: Download link
has-banned-items: You cannot teleport because you have these items in your inventory
insufficient-items: You are missing items that are required to teleport
insufficient-money: You do not have enough money to teleport to that waypoint. Additional money required
insufficient-xp: You do not have enough XP to teleport to that waypoint. Additional XP points required
invalid-name: Waypoint names must be 30 characters or fewer
invalid-name-alphanumeric: Waypoint names must be 30 characters or fewer and can only contain letters, numbers, spaces, underscores, and hyphens.
name-taken: There is already a public waypoint of that name
new-version-available: A new version of Beacon Waypoints is available!
next-page: Next Page
no-break-permission: You do not have permission to break beacons that have waypoints set
no-command-permission: You don't have permission to use that command
no-private-waypoint-permission: You don't have permission to create private waypoints
no-waypoint-permission: You don't have permission to create waypoints
not-owner: Only the owner of this beacon can create a public waypoint
options: Options
owner: Owner
payment-mode-not-found: Payment mode not recognized, defaulting to "none"
pinned: pinned
pin-waypoint: Pin waypoint
previous-page: Previous Page
private-list-full: Private waypoint list is full!
private-name-taken: There is already a private waypoint of that name
private-waypoint-options: Options for this private waypoint
private-waypoints: Private Waypoints
public-list-full: Public waypoint list is full!
public-waypoint-options: Options for this public waypoint
public-waypoints: Public Waypoints
removed-private-waypoint: Removed private waypoint
removed-public-waypoint: Removed public waypoint
required-items: Required Items
stand-on-beacon: You must be standing on a beacon to set a waypoint
unpin-waypoint: Unpin waypoint
updated-version: Updated version
waypoint: Waypoint
waypoint-does-not-exist: That waypoint doesn't exist!
waypoint-icon: Waypoint Icon
waypoint-icon-not-found: Could not add waypoint icon. No item found for
world-not-allowed: You cannot set a waypoint in this world

Note: If WorldEdit is used to delete a beacon, the waypoint will not be deleted. You will need to manually place back the beacon and break it, or use the setblock and fill commands instead.

Issue Tracker - Please report bugs here
Contact me on Discord: ti.mirro

Community Videos

Community Videos

YouTube
YouTube


Changelog

Similar projects

Plugin →