https://github.com/syr0ws/minewaypoints
MineWaypoints is a Spigot plugin to create, share and display waypoints in Minecraft.
https://github.com/syr0ws/minewaypoints
minecraft plugin spigot waypoints
Last synced: 3 months ago
JSON representation
MineWaypoints is a Spigot plugin to create, share and display waypoints in Minecraft.
- Host: GitHub
- URL: https://github.com/syr0ws/minewaypoints
- Owner: Syr0ws
- License: apache-2.0
- Created: 2024-12-08T14:40:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T22:00:33.000Z (over 1 year ago)
- Last Synced: 2025-04-05T22:24:51.137Z (over 1 year ago)
- Topics: minecraft, plugin, spigot, waypoints
- Language: Java
- Homepage: https://www.spigotmc.org/resources/minewaypoints-always-find-your-way-home.123628/
- Size: 274 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
 
# MineWaypoints
MineWaypoints is a plugin that enables players to create, share and display waypoints in Minecraft. With MineWaypoints, you will
always find your way home.
## Features
MineWaypoints comes with the following features:
- Create waypoints at specific locations.
- Limit the number of waypoints a player can create by permissions.
- Restrict the worlds in which players can create waypoints.
- Give a waypoint a custom name, icon and location.
- Update a waypoint name, icon and location.
- Visualize the waypoints you created.
- Display a waypoint to be able to go at its location.
- Delete a waypoint.
- Share a waypoint with another player through a sharing request.
- Accept / Cancel a waypoint sharing request.
- Visualize and manage the players a waypoint is shared with.
- Visualize the waypoints shared with you.
- Stop sharing a waypoint with a player or remove a shared waypoint.
- Manage your waypoints and shared waypoints through menus.
- SQLite (default), MySQL, MariaDB and PostgreSQL databases support.
- Fully customizable (general settings, messages, menus).
## Commands
- `/waypoints` → Open the waypoints menu to manage your waypoints and shared waypoints.
- `/waypoints create ` → Create a new waypoint.
- `/waypoints rename ` → Rename a waypoint.
- `/waypoints relocate ` → Update the location of the waypoint with the current one.
- `/waypoints share ` → Send a waypoint sharing request to a player.
- `/waypoints help` → Show the available commands.
> Note: The **/waypoints** command can also be used with the aliases **/waypoint** and **/wp**.
## Permissions
- `minewaypoints.command.waypoints` → Access to the `/waypoints` and `/waypoints help` commands.
- `minewaypoints.command.waypoints.create` → Access the `/waypoints create` command.
- `minewaypoints.command.waypoints.rename` → Access the `/waypoints rename` command.
- `minewaypoints.command.waypoints.relocate` → Access the `/waypoints relocate` command.
- `minewaypoints.command.waypoint.share` → Access the `/waypoints share` command.
## Integrations
MineWaypoints is designed to work seamlessly with other plugins through integrations. Currently supported plugins include:
| Plugin | Features |
|----------------|--------------------------------------------------------------|
| **WorldGuard** | Prevent waypoints from being located within defined regions. |
## Install
**Step 1**: Download the JAR file on [Spigot](https://www.spigotmc.org/resources/minewaypoints-always-find-your-way-home.123628/).
**Step 2**: Put the downloaded JAR file in the `plugins` folder of your Spigot server.
**Step 3** (optional): Open the `config.yml` file generated by the plugin and edit the configuration by following
the guidelines to customize the plugin as you wish.
## API
Developers can extend the behavior of the plugin by listening to the following events from the `com.github.syr0ws.minewaypoints.platform.spigot.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.