-
Notifications
You must be signed in to change notification settings - Fork 0
What is PathFinder?
PathFinder is a dedicated command parsing API for Minecraft mods. Its primary purpose is to structure and manage command data so that it can be used by external systems or user interfaces, such as the Ultimate Backport Mod, which provides the actual command suggestion UI.
Key points:
-
Command Parsing: PathFinder takes your mod’s commands and arguments and generates a structured JSON format. This makes your commands easy to read, validate, and process.
-
Separation of Concerns: The API itself does not include the in-game suggestion UI. That functionality lives in the Ultimate Backport Mod. PathFinder focuses purely on preparing and parsing the data.
-
Flexible Usage:
- For normal command suggestions, you do not need to integrate the API into your mod. Simply generate the command JSON and drop it into your
assets/<namespace>folder. - For dynamic suggestions (like real-time suggestions depending on things you add in your mod), you need to integrate PathFinder API into your mod.
- For normal command suggestions, you do not need to integrate the API into your mod. Simply generate the command JSON and drop it into your
Workflow Example:
- Generate command data via pathfinder.julianweinelt.de.
- Download the generated JSON.
- Place it in your mod’s
assets/<namespace>folder. - PathFinder API parses the commands and prepares them for use by other systems or UIs.
PathFinder is designed to be lightweight, modular, and easy to integrate, allowing mod developers to focus on their gameplay features while providing consistent command suggestions for players.
This documentation may contain information that is no longer available in the mod or has not been finally added to it.