Skip to content

fajzu1/Waypoint-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

44 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Banner

🌟 Features

  • Create, update, and remove waypoints
  • Custom names, icons, colors, and styling
  • Lightweight and fast integration
  • Fully documented API structure

  • Preview Video: Link

🧰 Requirements

πŸ“¦ Installation

Add the repository and dependency to your project:

Maven Repository

<repository> <id>github</id> <url>https://maven.pkg.github.com/fajzu1/Waypoint-API</url> </repository>

Maven Dependency

<dependency> <groupId>io.github.fajzu</groupId> <artifactId>waypoint-api</artifactId> <version>1.0-SNAPSHOT</version> </dependency>

βš™οΈ Usage

Injecting a WaypointAPI into Plugin

WaypointProvider waypointProvider = WaypointProvider.init(this);

Creating a Waypoint

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

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

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 - 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!