Wuufu's Waypoints is a port of
Maren's Waypoints, a portal management system which aims to unify what is normally separate plugins for portals, homes/warps, and spawns under an intuitive self-linking menu not unlike the waypoint system in Diablo 2. Focus is on providing players fun and easy ways to navigate the server's maps without ruining the Minecraft adventuring experience through instant gratification.
This project is relicensed under the
GNU General Public License version 3.
Using a waypoint is as simple as walking over any waypoint location (a single block) to open the waypoint directory and clicking on the destination. Server-defined waypoints can link to Spawn, Bed, all server-defined waypoints that a player has access, and the player's home waypoints. Home waypoints can travel between Spawn, Bed, and other home waypoints.
Once clicking on a destination, the player will be frozen in place and cannot pickup/drop items or pass commands. After a few seconds of techno-babble (or whatever you want it to be, as all messages can be edited in the config.yml) the player will be zapped to their destination, and will be free to move once again.
Home Waypoints
Home waypoints are player-defined locations that will show up in the waypoint directory. A player can have up to a configurable limit of home waypoints (three by default); creating any new waypoints beyond this limit will overwrite the oldest entry.
To add a home waypoint, simply right-click with a clock renamed to the desired waypoint name while sneaking. It will be created where the player is standing (and with their facing), consuming the clock in the process. A player can move their waypoint to a different location by repeating the process with an identically named clock in the new location.
A player can also manage their home waypoints using various items by right-clicking on the block the waypoint was created over while sneaking. If the item is a Written Book, its contents (up to the WP_DESC_MAX_LENGTH, which is configurable in config.yml) will become the waypoint's description in the directory. If the item is a named compass, the waypoint will be renamed to the compasses name, consuming the compass. To change the waypoint's icon in the directory, a player can use any unnamed item, and the item in the player's hand will be consumed, becoming the waypoint's new icon.
To remove a Waypoint, a Player can left-click on the block the waypoint was created over with an unnamed compass while sneaking. This will clear the Waypoint from the system.
Discovery Mode
Discovery mode allows a waypoint to be discovered by players who walk over its location. Discovered waypoints can be accessed without the access permission. This mode is disabled by default. "
/wp discover" will cycle through three discovery modes for the selected waypoint:
- Server-wide will allow discovered waypoints to show up globally
- World-specific only allows discovered waypoint to show in its own world
- Disabled disables discovery mode
Additionally, waypoints that are due to be discovered can be displayed in the waypoint menu so players can be enticed to look out for them, with a hint added for extra flavour.
Categories
Server-defined waypoints can additionally be placed into categories. This is useful if you have a large number of them, perhaps in conjunction with discovery mode.
See Categories Info
Waypoint Beacons
Waypoint Beacons provide remote teleportation functionality. As pictured above, the recipe to create one is a compass at the center of a crafting table surrounded by redstone.
Alternatively, the option
BEACON_AS_BOOK can be set to true in config.yml, which replaces the recipe with the above one (which is identical to the first except the bottom center block is a book instead of redstone), and the compass generated into an enchanted book. This is useful in 1.16 and above where compasses can be interfered with by lodestones, causing the beacons to stop functioning.
To use, right-click while holding the beacon. Normally, the beacon can only travel between home waypoints, but it can be expanded to include server-defined waypoints with the appropriate permission.
Beacons are consumed upon use, unless the player has the permission "
wp.beacon.unlimited". Additionally, players with this permission will always have a Waypoint Beacon in their inventory if
BEACON_UNLIMITED_PERMANENT is set to true in config.yml. However, they will no longer be able to drop it; and cannot interact with it in any way when an inventory other than their own is open.
Administrators with the "
wp.select.beacon" permission can also left-click with a beacon to quickly bring up the selection menu. Players can also be granted this permission, which will provide an easy way for players to select Home waypoints for further modifications using commands.
This item can be disabled from config.yml.
Respawns
Wuufu's Waypoints will also handle where your players spawn after they die. This feature can be enabled/disabled by setting "
HANDLE_RESPAWNING" to true or false in config.yml. There are four modes available:
- Home - Players will respawn at their closest waypoint for their current world
- Bed - Players will respawn at their bed location
- Spawn - Players will respawn at their current world's spawn
- City - Players will respawn at the spawn waypoint of the CITY_WORLD_NAME in config.yml
Whenever a location is unavailable (like if the player has no home waypoints in current world or a bed location), the player will respawn at the location below it. The priority is as follows: Home > Bed > Spawn. On the City spawn mode, players will always revive at the specified world's spawn waypoint.
Additionally, if players have the permission node "
wp.respawn", they will be able to right-click on their home waypoints with a Waypoint Beacon to set their respawn point. The block under the waypoint must be powered by redstone for the player to be able to set it as the respawn point, or for the player to revive at it. This requires both
ENABLE_BEACON and
HANDLE_RESPAWNING to be set to true.
Commands
See Full Commands List
Permissions
See Full Permissions List
Configuration
See Configuration Info
Optional Integrations
- NBT API - adds NBT tags to the plugin's items for identification purposes and support with plugins such as MMOItems. Please note that 1.18 requires version 2.9.0+ of this plugin to work, 1.19 requires 2.10.0+, and 1.20 requires 2.11.3+.
More Videos
Em Português