Navi

Navi

A client-side navigation library for Minecraft mods. Navi calculates routes and displays guidance in the world.

日本語の説明はページ後半にあります。

Features

• Routes for walking, swimming, climbing ladders and flying.
• Named waypoints and destinations, including moving entities.
• Travel through portal and teleport connections registered by the integrating mod.
• In-world route ribbons, destination markers and arrival events for the integrating mod.
• Settings for route preferences, appearance and performance.

For players

Navi is a library; it does not provide a standalone navigation interface. Use it with a mod that provides navigation destinations, such as Agent Bridge: Navigation (with Agent Bridge and a Codex or Claude connection extension). Navi does not move the player or operate teleport devices.

HUD, settings screens, controls and preference storage are provided by the integrating mod.

Routes use terrain available to the client. Connections added by other mods need to be registered; Navi does not automatically recognize every portal or teleporter. Nearby target outlines can be visible through blocks. Check the rules of the server you play on.

For mod authors

Developer guide and API reference — setup, examples and versioned dependencies.

Navi allows one active navigation at a time. Starting another while it is active returns an error.

Pass your MOD ID when starting navigation. A successful start returns an object for reading, updating or stopping that journey, so integrations do not overwrite each other’s routes.

日本語

NaviはMinecraftのMODから使うクライアント用ナビゲーションライブラリです。経路を計算し、ワールド内に案内を表示します。

機能

• 徒歩・泳ぎ・はしご・飛行に対応した経路案内。
• 名前付きの経由地点・目的地と、移動するエンティティへの案内。
• 利用側のMODが登録したポータルやテレポート接続を使う移動。
• ワールド内の経路リボン・目的地マーカーと、利用MODへの到着イベント通知。
• 経路の好み・見た目・性能の設定。

プレイヤー向け

Naviはライブラリで、単体では案内を操作する画面を持ちません。たとえばAgent Bridge: Navigationに、Agent Bridge本体とCodexまたはClaudeの接続拡張を組み合わせて使います。Naviがプレイヤーを動かしたり、転送装置を操作したりすることはありません。

HUD・設定画面・操作・設定の保存は、利用側のMODが提供します。

経路にはクライアントが把握している地形を使います。他MODのポータルやテレポーターをすべて自動認識するものではなく、接続情報の登録が必要です。近くの目標の縁取りはブロック越しに見える場合があります。遊ぶサーバーのルールを確認してください。

MOD開発者向け

開発者ガイドとAPIリファレンスに、導入手順・使用例・バージョンごとのGradleの依存指定を掲載しています。

同時に実行できるナビは1件です。すでに案内中の場合、新しい開始要求はエラーになります。

開始時にMOD IDを渡すと、その案内を操作するオブジェクトが返ります。状態取得・更新・停止はこのオブジェクトから行い、利用するMOD同士が互いの経路を上書きしない仕組みです。