Navi API
Add in-world navigation to your client mod. Navi calculates walkable routes, renders the route and destination, and provides its own navigation HUD and settings. Your mod supplies the destination and owns the request.
New integration? Start with Getting started, then Ownership & lifecycle. 日本語はこちら。
What you can build
- Guide players to a location, named waypoints or an observed entity.
- Describe portals and other transfers as directed connections between locations.
- Refine an active journey without replacing its destination or consumed progress.
- Save remaining navigation intent and restore it on the next visit.
- Observe progress and terminal events without reading Minecraft internals.
Navi supplies guidance; it does not move the player, activate teleporters, or execute game commands. It works without an AI connection.
The integration boundary
| Your mod | Navi |
|---|---|
| Destination, waypoint names, known transfer connections | Route calculation, tracking, route rendering |
| Request key and application lifecycle | One active navigation shared by all calling mods |
| Per-world checkpoint storage | Checkpoint creation and validation |
| Optional investigation of an unresolved route | Current status and assistance incident |
NaviClient.navigation() is the Minecraft-facing entry point. The public contracts live under dev.miyomiyo.navi.api. Internal packages and engine classes are implementation details.
Version 1.0.0
This reference describes Navi 1.0.0. Use a matching artifact for your Minecraft version and loader. The installation belongs on the client; dedicated servers do not provide this API.
The API and downloadable artifacts retain the Navi license: All Rights Reserved. Depending on Navi does not require embedding it in your mod.