https://github.com/fajzu1/waypoint-api
🚀 Waypoint API for Minecraft 1.21.6+ with new locationBar integration.
https://github.com/fajzu1/waypoint-api
api bar bukkit java location locationbar mc-api minecraft minecraft-api minecraft-java minecraft-plugin minecraft-waypoints navigation paper purpur spigot waypoint-api waypoints waypoints-navigation
Last synced: 1 day ago
JSON representation
🚀 Waypoint API for Minecraft 1.21.6+ with new locationBar integration.
- Host: GitHub
- URL: https://github.com/fajzu1/waypoint-api
- Owner: fajzu1
- License: gpl-3.0
- Created: 2025-12-03T22:24:34.000Z (22 days ago)
- Default Branch: master
- Last Pushed: 2025-12-04T21:01:27.000Z (21 days ago)
- Last Synced: 2025-12-07T04:44:47.990Z (19 days ago)
- Topics: api, bar, bukkit, java, location, locationbar, mc-api, minecraft, minecraft-api, minecraft-java, minecraft-plugin, minecraft-waypoints, navigation, paper, purpur, spigot, waypoint-api, waypoints, waypoints-navigation
- Language: Java
- Homepage:
- Size: 226 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
## 🌟 Features
- Create, update, and remove waypoints
- Custom names, icons, colors, and styling
- Lightweight and fast integration
- Fully documented API structure
---
- Preview Video: [Link](https://www.youtube.com/watch?v=FkM1QbLYQs0)
## 🧰 Requirements
- Server version 1.21.6+
- [PacketEvents](https://github.com/retrooper/packetevents)
- [Java](https://www.java.com/en/) 21+
## 📦 Installation
Add the repository and dependency to your project:
#### Maven Repository
```xml
github
https://maven.pkg.github.com/fajzu1/Waypoint-API
```
#### Maven Dependency
```xml
io.github.fajzu
waypoint-api
1.0-SNAPSHOT
```
---
## ⚙️ Usage
#### Injecting a WaypointAPI into Plugin
```java
WaypointProvider waypointProvider = WaypointProvider.init(this);
```
#### Creating a Waypoint
```java
Waypoint waypoint = WaypointBuilder
.builder()
.position(new Location(
"world",
0,
100,
0
))
.style(WaypointStyle.DEFAULT)
.color(Color.BLACK)
.build();
waypointProvider.track(player, waypoint);
```
#### Updating a Waypoint
```java
Waypoint waypoint = ...
waypoint
.toBuilder()
.color(Color.BLUE)
.style(WaypointStyle.of("custom", "path"))
.position(new Location(
null,
10,
200,
10
))
.build();
waypointProvider.update(player, waypoint);
```
#### Removing a Waypoint
```java
Waypoint waypoint = ...
waypointProvider.hide(player, waypoint);
```
---
## 🐞 Found a Bug?
Spotted an issue? Report it via Discord: **fizuxd** 💬
---
## 🗂️ TODO
- Add Bukkit Events handling for creating/updating/removing waypoint
## ❤️ Thanks for Your Support!
- [notnwse](https://github.com/notnwse) - for significant enhancements and optimizations to the code
If you enjoy using Waypoint-API, leave a ⭐ on the GitHub repo and share it with your friends!