MineWaypoints | Always find your way home! [1.17+]

MineWaypoints | Always find your way home! [1.17+] -----

Create, manage, share and display waypoints in Minecraft!

Download Now
522.8 KB .jar

MineWaypoints v1.6.0 | Adding MariaDB support and fixing some issues

Features:

Adding MariaDB database support. The driver mariadb can now be used in the property database.driver of your config.yml file.

Fixes:

Fixing the message unshare.by-owner-to-owner default configuration by fixing colors and by replacing the invalid placeholder %target_name% by %shared_with_name%.
Adding a check to avoid NullPointerException when disabling integrations.
Internal refactoring.

----------, May 5, 2025

Minewaypoints v1.5.0 | Switching to an hexagonal architecture

Internal changes:

Reworking the internal package organization of the project to switch to an hexagonal architecture which is more maintainable, modulable and easier to test.
Adding architectural tests.

----------, May 3, 2025

MineWaypoints v1.4.0 | Add forbidden worlds and a permission-based waypoint creation limit

Features:

Replacing the global waypoint limit by a permission-based system to limit the number of waypoints a player can create. When a player has reached its waypoint limit and is trying to create a new waypoint, a message will be sent to inform it that it has reached the limit.

Note: This feature is entirely configurable in your config.yml file (see the How to update? section to integrate it in your current configuration).

Adding support for forbidden worlds in which players cannot create waypoints. When a player is trying to create a waypoint in a forbidden world, a message will be sent to inform it that it is not possible. No AsyncWaypointCreateEvent will be called.

Note: This feature is entirely configurable in your config.yml file (see the How to update? section to integrate it in your current configuration).

Documentation:

Fixing invalid permission names with missing prefix minewaypoints. in the README.md and the Spigot presentation.

Improving the documentation in the README.md file.

Other changes:

Internal refactoring.

Renaming the key messages.errors.waypoint.invalid-world to messages.errors.waypoint.world-changed in the config.yml file.

How to update?

If you want to update to this version by keeping your current configuration, please do the following actions in your config.yml file.

Remove the waypoint-limit key from your config.yml file.

Code (YAML):

# The maximum number of waypoints a player can create.
# Set -1 to allow an unlimited number of waypoints.
waypoint-limit : 50

Add the following code at the end of the GENERAL section in your config.yml file.

Code (YAML):

# Permission-based system to define the maximum number of waypoints a player can create.
# If a player has several permissions, the one that allows the highest number of waypoints will be used.
# You are free to add as many permissions you want and to give them custom names.
# Set -1 to the limit field to allow an unlimited number of waypoints.
waypoint-creation-limits:
- permission : "waypoints.create.limit.default"
limit : 25
- permission : "waypoints.create.limit.admin"
limit : -1

Add the following code at the end of the GENERAL section in your config.yml file.

Code (Text):

# List of worlds players cannot create waypoints in.
forbidden-worlds:
- world-example-1
- world-example-2
- world-example-3

Rename the key messages.errors.waypoint.invalid-world to messages.errors.waypoint.world-changed in your config.yml file.

Code (YAML):

# Message sent when a player is trying to change the location of a waypoint to another world.
# Available placeholders: %waypoint_world%.
world-changed : "&c>> The world of the waypoint cannot be changed."

Add the following code in the messages.errors.waypoint section in your config.yml file.

Code (YAML):

# Message sent when a player is trying to create a waypoint in an invalid world.
# Available placeholders: %waypoint_world%.
forbidden-world : "&c>> Waypoints are forbidden in this world."

----------, Apr 25, 2025

MineWaypoints v1.3.0 | /waypoints command update

Features:

Adding auto-completion support for static and dynamic arguments when using the /waypoints command.

Adding dynamic help based on the sender's permissions for the /waypoints command. Now, only command usages the sender has access to will be sent.

Internal changes:

Integrating the SmartCommands library.

The /waypoints command has been refactored using the SmartCommands' annotation-based system.

Adding a cache system to provide efficient auto-completion for waypoint names.

Breaking changes:

This update requires an update of your config.yml file. If you want to keep your configuration, you can modify the value at messages.command.waypoints.usages by replacing it by the following code.

Code (YAML):

# Command /waypoints help
usages:
show : "&6/waypoints &7to open the waypoints menu."
create : "&6/waypoints create &e<waypoint_name> &7to create a new waypoint at your current location."
rename : "&6/waypoints rename &e<waypoint_name> <new_name> &7to rename a waypoint."
relocate : "&6/waypoints relocate &e<waypoint_name> &7to replace the location of the waypoint by your current location."
share : "&6/waypoints share &e<waypoint_name> <target_name> &7to share a waypoint with a player."

----------, Apr 23, 2025

MineWaypoints v1.2.0 | WorldGuard integration

Features:

Adding WorldGuard integration to prevent waypoints from being located in defined regions. This feature is disabled by default and can be enabled in the config.yml file.

Breaking changes:

This update requires an update of your config.yml file. If you want to keep your configuration, you can add the following code at the end of the file.

Code (YAML):

####################################################
### INTEGRATIONS ###
####################################################

# WorldGuard integration.
# https://dev.bukkit.org/projects/worldguard
worldguard :
# Set true to enable the WorldGuard integration. Otherwise, set false.
enabled : false
# Define regions where waypoints are not allowed.
# Note: This prevent waypoints from being created or relocated in the specified regions. This setting has no effect
# on waypoints which are already located in the specified regions.
forbidden-regions :
- "region-1"
- "region-2"
- "region-3"
messages :
# Message sent to a player when it is trying to define a waypoint in a forbidden region.
forbidden-region : "&c>> You are not allowed to have a waypoint in this area."

----------, Apr 12, 2025

MineWaypoints v1.1.0 | Adding an event API

Features:

Developers can now listen to the following waypoint-related events from the com.github.syr0ws.minewaypoints.api.event package:
- AsyncWaypointCreateEvent: Called when a player attempts to create a new waypoint.
- AsyncWaypointCreatedEvent: Called when a waypoint has been created by a player.
- AsyncWaypointDeleteEvent: Called when a player attempts to delete one of its waypoints.
- AsyncWaypointDeletedEvent: Called when a waypoint has been deleted by its owner.
- AsyncWaypointSharingRequestSendEvent: Called when the owner of a waypoint sends a sharing request to a player.
- AsyncWaypointSharedEvent: Called when a waypoint has been shared with a player.
- AsyncWaypointUnshareEvent: Called when a player is trying to stop sharing a waypoint.
- AsyncWaypointUnsharedEvent: Called when a waypoint is no longer shared with a player.
- AsyncWaypointUpdateEvent: Called when a player attempts to update one of its waypoint.
- AsyncWaypointUpdatedEvent: Called when a waypoint has been updated its owner.

Rework:

Reworking the way waypoint data updates are handled.

Breaking changes:

This update requires an update of your config.yml file. If you want to keep your configuration, you can add the following entry in the messages.errors.waypoint section.

Code (Text):

# Message sent when a player is trying to rename a waypoint using the same name.
same-name: "&c>> The waypoint name must be different from the current one."

----------, Apr 11, 2025

MineWaypoints v1.0.3 | Internal changes

Internal changes: