Waypoints
Ever had the problem, that you were on a long trip and can't find your base?
You could set a warp with a conventional plugin at your home and simply teleport back. But if you want to keep the survival experience of not being able to teleport like that, this plugin could be just what your server needs!
Direction Indicators
So, instead of just bringing the player back where he started, this plugin shows him the direction he has to walk, so he can explore the world even more. To show the player the direction you can configure multiple direction indicators to guide the player to his destination.
Bossbar Indicator
A compass will be visible at the top of the screen, with a highlighter marking in which direction the waypoint is
Beacon
When the waypoint is in render distance, a beacon beam will appear at the location of the waypoint to make it easier to pinpoint the location of the waypoint.
Hologram
Floating text like in the mods.
Blinking Block
When the player is closer to the waypoint, the beacon will be replaced with a block sequence that will repeat. This is to help him get to the exact location.
Compass
It won't get any simpler than that if the player owns a compass. It will have the waypoint as it's target and points into that direction.
Actionbar Indicator
This is comparable to the compass but doesn't require one. It will show the rough direction with small sections in the action bar of the player. If the player is too far left, the sections in the right will light up and vice versa.
Particles
Particles appear at the feet of the player pointing into the direction of the waypoint
Player tracking
Although disabled by default, when enabled adds a menu to the GUI where the player can choose another player to track. Now the compass, actionbar indicator and particles will help guide the player to the tracked player.
- Players can choose to hide themselves in the menu to others (if enabled)
- Players must show themselves to others in order to track a player (if enabled)
- The player that gets tracked receives a notification who started tracking him (if enabled)
Languages
The plugin is shipping translations for the following languages:
- English
- German
- Italian (by marcotech81)
- Simplified Chinese (by SnowCutieOwO)
- Traditional Chinese (by ItzTheBear)
- Brazilian Portuguese (partial, by gaugt980131gg2)
- Japanese (by Niboshi201)
And if your language is not there, the plugin is fully translatable
Other notable features
- Open the GUI by sneaking and right-clicking with a compass (by default)
- Set custom icons for waypoints and folders by clicking on their icon. The item in your main hand will be used
- Limit the amount of waypoints and folders a player can have
- Customizable teleport prices and price increases the more the player teleports (With Vault support)
- Direction indicators customizable
- Items in GUI fully customizable
- SQLite data storage
Integrations
Videos
DonKolia made a small video series of this plugins functionality where he demonstrates the basic functionality and all the available pointers. It is in Spanish but with English subtitles: Link to playlist
Commands
/waypoints - Opens the GUI
/waypoints select <Name> - Select an additional waypoint
/waypoints deselectAll - Deselect all selected waypoints
/waypoints teleport <Name> - Teleport to waypoints (if allowed)
/waypoints set <Name> - Create a waypoint only the player himself can see
/waypoints setPublic <Name> - Create a waypoint visible for everyone
/waypoints setPermission <Permission> <Name> - Create a waypoint only visible for players with the given permission
/waypoints setTemporary <X> <Y> <Z> - Create a waypoint that is only visible for the time he is online
/waypoints other <Name> - View the waypoints of another player
/waypoints statistics - Look at some rudimentary statistics about the database
/waypoints reload - Reload the configuration. (/reload is not supported)
Scripting
/waypointsscript deselectWaypoint <Player-Name> - Deselect the current waypoints of a player with a command
/waypointsscript selectWaypoint <Player-Name> <Waypoint-UUID> - Set the waypoint selection of a player with a command
/waypointsscript temporaryWaypoint <Player-Name> <X> <Y> <Z> [Beacon-Color] - Create a temporary waypoint for the player
/waypointsscript uuid <Search-Query> - Search for waypoints by their name to get the uuid of them
Permissions
waypoints.command.use* - Allows the player to use the /waypoints command and open the GUI
waypoints.command.other - Allows the player to use the /waypoints other command
waypoints.command.statistics - Allows the player to use the /waypoints statistics command
waypoints.command.reload - Allows the player to use the /waypoints reload command
waypoints.command.scripting - Allows the player to use the /waypointsscript command and get the UUID of waypoints
waypoints.modify.private* - Allows the player to create, alter and delete private waypoints
waypoints.modify.public - Allows the player to create, alter and delete public waypoints
waypoints.modify.permission - Allows the player to create, alter, delete and always see permission waypoints
waypoints.modify.anywhere - Allows the player to place waypoints wherever they want, ignoring disabled worlds
waypoints.modify.other - Allows the player to modify the waypoints of another player when using /waypoints other
waypoints.unlimited - Allows the player to create more waypoints and folders than the limit in the config
waypoints.temporaryWaypoint* - Allows the player to create a waypoint that is only visible for the time he is online
waypoints.temporaryWaypoint.other* - Allows the player to create a waypoint for select players that is only visible for the time they is online
waypoints.teleport.private - Allows the player to teleport to private waypoints
waypoints.teleport.public - Allows the player to teleport to public waypoints
waypoints.teleport.permission - Allows the player to teleport to permission waypoints
waypoints.tracking.enabled* - Allows the player to use the player tracking feature
waypoints.tracking.trackAll - Allows the player to track players that are hidden
waypoints.updateNotification - The player receives a notification after a server restart if a new Version is found
*: These permissions are granted to all players by default
Configuration
Almost everything is configurable. To have a look at the current configuration file click here
Also, you can change every piece of text to other languages or just change the colors. English Translation File
Additional notes
Metrics
This plugin uses bStats to collect basic metrics about the usage of this plugin. You can, of course, opt-out of this if you wish. For further information have a look at "What data is collected?" and "How to disable bStats" over here.
To view the metrics of this plugin, go here.
Java version
Java 21 is the minimum required version.
All Versions
+ Add Version| Name | Game version | Platforms | Published | Downloads | Actions |
|---|---|---|---|---|---|
|
R
5.0.0
|
1d ago | 1 | |||
|
R
4.5.13
|
1d ago | 1 | |||
|
R
4.5.12
|
1d ago | 1 | |||
|
R
4.5.11
|
1d ago | 1 | |||
|
R
4.5.10
|
1d ago | 1 | |||
|
R
4.5.9
|
1d ago | 1 | |||
|
R
4.5.8
|
1d ago | 1 | |||
|
R
4.5.7
|
1d ago | 1 | |||
|
R
4.5.6
|
1d ago | 1 | |||
|
R
4.5.5
|
1d ago | 1 | |||
|
R
4.5.4
|
1d ago | 1 | |||
|
R
4.5.3
|
1d ago | 1 | |||
|
R
4.5.2
|
1d ago | 1 | |||
|
R
4.5.1
|
1d ago | 1 | |||
|
R
4.5.0
|
1d ago | 1 | |||
|
R
4.4.3
|
1d ago | 1 | |||
|
R
4.4.2
|
1d ago | 1 | |||
|
R
4.4.1
|
1d ago | 1 | |||
|
R
4.4.0
|
1d ago | 1 | |||
|
R
4.3.2
|
1d ago | 1 | |||
|
R
4.3.1
|
1d ago | 1 | |||
|
R
4.3.0
|
1d ago | 1 | |||
|
R
3.6.6
|
1d ago | 1 | |||
|
R
4.2.0
|
1d ago | 1 | |||
|
R
4.1.0
|
1d ago | 1 | |||
|
R
4.0.2
|
1d ago | 1 | |||
|
R
4.0.1
|
1d ago | 1 | |||
|
R
4.0.0
|
1d ago | 1 | |||
|
R
3.6.5
|
1d ago | 1 | |||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
|
R
3.6.2
|
1d ago | 1 | |||
|
R
3.6.1
|
1d ago | 1 | |||
|
R
3.6.0
|
1d ago | 1 | |||
|
R
3.5.9
|
1d ago | 1 | |||
|
R
3.5.8
|
1d ago | 1 | |||
|
R
3.5.7
|
1d ago | 1 | |||
|
R
3.5.6
|
1d ago | 1 |
- 1.21.8 is now required**
- Config format changed** (with automatic migration)
- Inventory config changed (with automatic migration)
- Namespaced keys (
grass,minecraft:grass,datapack:grass) - Custom model data changed/fixed
- API for plugins to consume no longer available
- Trail pointer (with the pathfinder) has been dropped
- Teleportation is disabled entirely by default
- The
waypoints.teleport.private,waypoints.teleport.publicandwaypoints.teleport.permissionpermissions are no longer granted by default to operators due to confusion when configuring
### Added
- Option to remove spaces in durations for CJK languages
- Presets to make some configurations easier instead of having to do them manually in the big configuration file
- Option to show permission and private waypoints on web maps (BlueMap, DynMap, Pl3xMap or SquareMap)
- Config option to periodically backup the database
- Japanese translation by Niboshi201
### Changed
- ProtocolLib is no longer required for editing descriptions of waypoints or folders
- Banner patterns (also applies to banner waypoints), armor trims and dye colors are now stored for custom icons
- Use Modrinth API for update checking
- Public and permission waypoints can be enabled/disabled separately
- Permission waypoints are disabled by default now
- With public ownership enabled, players can now convert their private waypoints to public ones
### Fixed
- Potential memory leak. Close PreparedStatements after use
- GUI will no longer open after placing a named banner on a wall
- IllegalStateException is thrown on Folia when switching between worlds when they are not linked (like overworld and the nether are for example) [#121](https://github.com/Sytm/waypoints/issues/121)
- IllegalStateException could be thrown on Folia when switching between any worlds
- IllegalStateException is thrown on Folia when entering a description using the sign gui [#119](https://github.com/Sytm/waypoints/issues/119)
- RunningOnDifferentThreadException is thrown when creating a waypoint inside a folder
- When placing named banners, private waypoints will automatically be created
- RunningOnDifferentThreadException that sometimes occurs when using the GUI
- Improved error message when the loading of a custom web map icon from
plugins/Waypoints/iconsfails
### Fixed
- Error when trying to edit the description of a waypoint / folder
- Error when switching worlds with the Hologram pointer enabled
- Workaround fix for hologram disappearing when switching worlds
- Error when a waypoint has a custom web map icon set and the file does not exist in the
plugins/Waypoints/iconsdirectory
/waypointsscript trackPlayer <player> <target>command to script the tracking of other players. Does not require player tracking to be enabled in the config
### Fixed
- Immediately cancel pointer tasks at server shutdown [#116](https://github.com/Sytm/waypoints/issues/116)
- Plugin not working on 1.21.1 - 1.20.6
- Option to disallow teleports to different worlds
- Variable containing the distance between a player and waypoint for the cost formula (
distance) - Option to hide waypoints that are in different worlds as the player
- Use custom Bedrock window to accept tracking request instead of (broken) clickable link in chat
### Fixed
- Warning that a world name has not been translated is printed multiple times
- PointerManager API that directly uses Waypoints or players for targets
### Fixed
- Some Simplified Chinese translations still missing by SnowCutieOwO
- Traditional Chinese translations by ItzTheBear
- Option to apply cooldowns from one waypoint type to other ones (
general.teleport.private/death/public/permission.alsoApplyCooldownTo) - Option to automatically deselect the automatically selected death waypoint after a certain time (
general.pointToDeathWaypointOnDeath.autoDeselectAfter)
### Changed
- CommandAPI is no longer required**
- Updated Simplified Chinese translations by SnowCutieOwO
- When using
/waypoints other <...>to inspect another players waypoints, the waypoints can now be modified and removed when the player has the permissionwaypoints.modify.other - Disable plugin remapping on 1.20.6+ servers because this plugin does not utilize NMS
- Each page in the GUI has now a different title, instead if it being a single static one
- On the waypoint page in the GUI the current beacon color is now shown
### Fixed
- When having public ownership enabled, the owner is also displayed at the bottom of the waypoint and folder description for private ones
- Being unable to set a clear/non colored beacon beam
- Allow players to create public waypoints and folders that only the creator can manage. Feature must be manually enabled in config
### Fixed
- Fix NullPointerException with cooldowns when teleportations are enabled
- More world checks added to the trail pointer logic to prevent error spam on world switching
- Error spam from the hologram pointer when switching worlds outside the spawn chunks
- Error messages get printed into the console when the trail pointer is active and the player switches worlds
- Ability to pay for teleportations with experience points in addition to levels
### Fixed
- Thread check is triggered when a player sees the blinking block and teleports away on Folia [Sytm/quest-pointers#1](https://github.com/Sytm/quest-pointers/issues/1)
- An exception is thrown when using the trail pointer to point to a waypoint in another world [#106](https://github.com/Sytm/waypoints/issues/106)
- Additional limits can be specified that check for permissions to allow for staggered waypoints or folder limits
### Changed
- The movement of the hologram pointer has been smoothed, but the plugin now requires at least 1.20.2
- The seeds for sounds are now set by the plugin instead of the server to prevent them breaking in a future Paper update
### Fixed
- NullPointerException is thrown when trying to edit the icon of something with empty hands
- Anvil text input not working with EcoEnchants or UberEnchant installed
- Hologram pointer throwing errors on servers running Paper 1.20.1 and earlier.
- The GUI supports the usage of custom player heads
- Custom model data is stored when changing the icon of a Waypoint or folder
- Custom model data can be set for items in the GUI like this:
DIAMOND|1
### Changed
- CommandAPI is no longer bundled with Waypoints, but needs to be downloaded separately from [here](https://modrinth.com/plugin/commandapi)**
- Now Waypoints itself no longer requires updates between different Minecraft versions at all, only CommandAPI
- Partial update of chinese translations by [SnowCutieOwO](https://github.com/SnowCutieOwO)
- The default config has been updated to replace some items with custom player heads
- Holograms are now multiline by default
- The color of the indicators in the boss bar no longer change every settings change or plugin config reload
### Fixed
- Default colors for beacon beams are not applied
All further updates (like v4) will only be available on [Modrinth](https://modrinth.com/plugin/waypoints)
### Added
- Support for Minecraft 1.20.2
- Support for Minecraft 1.20.2
- Death folders can now be deleted in its entirety
- Temporary waypoints can be set for other players with
/waypoints setTemporary x y z [<players>] [<players>]can either be a player name or a selector like@a- The permission
waypoints.temporaryWaypoint.othersis required to perform this action, but all players have it by default - Players can disable the receiving of temporary waypoints by others in their settings
### Changed
- ProtocolLib is no longer required for hologram pointers
- The titles of the anvil text prompts are now customized
- Updated Vault usage metric to better reflect actual usage
### Fixed
- Hologram pointers work across dimensions changes
- Hologram pointers not showing the distance to the target when in a connected world
- Connected worlds not working by default. To apply this fix to existing users:
- Either regenerate the config.yml
- Or update
pointers.connectedWorlds.worldfromworld_the_nethertoworld_nether
- Added feature flag for teleportations at
general.features.teleportation - Added player tracking requests [#102](https://github.com/Sytm/waypoints/issues/102)
- Added Italian translations provided by marcotech81
### Fixed
- Fixed another incorrect translation mapping
### Removed
- Java interoperability helpers for API
- Error when opening the inventory while another player is selected [#101](https://github.com/Sytm/waypoints/issues/101)
- Java interoperability helpers have been added to the API Waypoints provides to allow non-Kotlin plugins to use it
### Fixed
- Plugin not properly loading on Minecraft 1.19.4
### Changed
- SignGUI for description editing uses newer API which has been added in 1.20.1
Before updating please make an update of your database to make sure nothing goes missing in case of unforeseen errors.
I have tested this plugin in the current state for quite some time and it worked without issues for me, but if you encounter any
please report them on the GitHub issue tracker or on the Discord server.
### Breaking changes
- Support for Spigot has been dropped, [Paper](https://papermc.io/software/paper) is required
- Only latest Minecraft version is officially supported, although the minimum Version is 1.19.4
- Translation files are now formatted with [MiniMessage](https://docs.advntr.dev/minimessage/format.html) instead of legacy color codes
- Database format has been updated and is not backwards compatible
- When using
/waypointsscript selectWaypointit is now mandatory to run/waypointscript deselectWaypointjust before if only one waypoint should be active at the same time
### Added
- Command suggestion tooltips are now customizable via the translation files at
command.search.tooltip - Update checker that notifies the console on startup and admins once after they first join. Can be disabled in the config at
general.updateChecker. Does not run periodically - Database accesses are now completely asynchronous to the main server thread
- Add support for [Folia](https://papermc.io/software/folia)
- Multiple Waypoints can be selected at the same time [#92](https://github.com/Sytm/waypoints/issues/92)
- Integration to [Pl3xMap](https://modrinth.com/plugin/pl3xmap) has been added
- Descriptions have been added to waypoints and folders. To change them [ProtocolLib](https://github.com/dmulloy2/ProtocolLib) needs to be installed
- A Particle Trail pointer has been added
- Players can choose to disable some of the server-wide available pointers (For example only having the bossbar)
- Players can share private waypoints with other players
- Sounds have been added to the GUI and some actions. They can be customized in the config at
sounds
### Changed
- Command help messages use used alias again
- The Hologram Pointer uses display entities instead of ArmorStands
- Added extra item in the waypoint gui page for changing the icon of waypoints
- Reloading has always been discouraged but is now explicitly unsupported
### Removed
- Compass pointer nether support has been removed, because any possible implementation is inherently inconsistent
- Add support for Minecraft 1.20
- In the future the only available downloads will be here on Modrinth**
Note on future versions:
v3 will only receive updates until Minecraft 1.21 (so basically 1.20.1, ...) but no more after that.
v4 will be released soon with serval enhancements which require the use of Paper due to required additional APIs that Spigot does not provide and overall better performance, so if you haven't switched yet, [now would be the time to do so](https://papermc.io/software/paper). (Paper is not _yet_ updated to 1.20)