https://github.com/cubbossa/pathfinder
A path finding tool for minecraft to make your maps discoverable and enable navigation
https://github.com/cubbossa/pathfinder
Last synced: about 1 year ago
JSON representation
A path finding tool for minecraft to make your maps discoverable and enable navigation
- Host: GitHub
- URL: https://github.com/cubbossa/pathfinder
- Owner: CubBossa
- License: mit
- Created: 2022-06-14T09:26:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T10:11:51.000Z (about 2 years ago)
- Last Synced: 2024-04-23T02:26:40.323Z (about 2 years ago)
- Language: Java
- Homepage: https://docs.leonardbausenwein.de/
- Size: 7.76 MB
- Stars: 15
- Watchers: 1
- Forks: 2
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GPS - PathFinder
---
## What is it
Pathfinder is a plugin for minecraft servers, that allows administrators to set up graphs of waypoints and connecting edges. This roadmap can then be used to visualize shortest paths, discover points of interest and more.
For more details check the [docs](https://docs.leonardbausenwein.de/getting_started/introduction.html).
## Contribution
### Building
`./gradlew build`
### Running
`./gradlew runServer`
### Publishing
`./gradlew publish`
## Dependency
The pathfinder artifact can be found in a nexus repository:
```kotlin
repositories {
maven("https://nexus.leonardbausenwein.de/repository/maven-public/")
}
dependencies {
implementation("de.cubbossa:pathfinder-core:[VERSION]")
}
```
``` xml
cubbossa
https://nexus.leonardbausenwein.de/repository/maven-public/
de.cubbossa
pathfinder-core
[VERSION]
```
## Project Structure
### pathfinder-core
The main module that handles RoadMaps, Waypoints, Nodegroups and the according logic.
It is to be used as API for now. Interesting classes might be `NodeType`, `VisualizerType`, `PathVisualizer`
and the matching handlers `NodeTypeHandler` and `VisualizerHandler`. More information on using the
API will be added to the docs soon.
### pathfinder-graphs
The logic for path solving on graphs. It is a dependency of `pathfinder-core` and has to be
shaded into the core module, otherwise exceptions will occur.
### pathfinder-editmode
Adds an ingame editor for RoadMaps. It uses clientside armorstands and particles to display
waypoints and edges and requires [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/).
It is not necessary to shade `pathfinder-editmode` into core. The module registeres itself to core
as a service once it is shaded. If it is not, the ingame command `/roadmap editmode ` will not work.
You can also use your own editmode visualizer by implementing the RoadMapEditor interface
and registering a RoadMapEditorFactory service class.
### pathfinder-scripted-visualizer
Adds a pathvisualizer to the core module that uses javascript to define particle behaviour.
Particles can be shifted by using complex math expressions. The visualizer requires a heavy
script engine service to be shaded into the jar. Therefore, it is a separate module that is again
not necessary for core to function. It implements the PathPluginExtension Service interface and
registers the VisualizerType implementation to the VisualizerHandler from core.