All pluginsMC Skylines

Plugin reference

MCSkylines-Navigation

Version 1.0.2 · Documentation refreshed October 12, 2026

Private property and chest-shop navigation with bus guidance.

Required plugins: MCSkylines-Economy, MCSkylines-Property, MCSkylines-Vehicles, WorldGuard. Optional integrations: MCSkylines-Fire.

01

Feature reference

What it handles

Feature overview

Setup and operation

Read the operator guide, commands and permissions below.

02

Mechanics, workflows & reference

Encyclopedia

Contents · jump to a topic

Configuration defaults: Values shown for operator-configurable settings are the bundled defaults, and can be changed in the module’s configuration or definitions. The server’s active settings take precedence, so costs, speeds, ranges, durations, chances, effects, recipes, limits and enabled features may differ. Command examples illustrate syntax; fixed mechanics and validation bounds are not configuration defaults.

Navigation finds registered Property regions and Economy chest shops, displays private directional guidance and plans useful NPC bus journeys. It uses current shop templates/prices without loading remote inventories.

Player commands

  • /navigate <region> or /nav <region> starts guidance to a registered Property region in the player's current world. /navigate <world:region> accepts an explicit world, but travel between worlds is not routed. /navigate stop ends guidance. Permission: , granted by default.
  • /find searches for the exact serialized identity of the main-hand item. /find buy, /find sell, and /find both use the held item with the indicated filter.
  • /find [buy|sell|both] <item name> searches active shops by a case-insensitive partial match on the shop item's display name or vanilla material name, with spaces, hyphens, and underscores treated alike. Names of listed custom items, including guns, are searched from their actual shop templates. Permission: , granted by default.

buy means the player buys from a shop, sorted by the lowest unit price. sell means the player sells to a shop, sorted by the highest unit price. both sorts by the best buy price and shows both buy and sell prices when the property has both kinds of offer. Each GUI entry groups the matching shops in the most specific registered Property region. A shop outside registered Property regions is its own result. When several offers share a region, the cheapest buy offer and highest sell offer supply its prices, even if their stock is unavailable. Clicking navigates to the offer selected for the filter; both prefers an available buy offer, then an available sell offer.

The GUI shows a chest for an available offer, red glass for an empty sell shop or full buy shop, and gray glass when the chest's chunk is not loaded so its live stock cannot be checked. Hover text shows owner, region, distance, buy and sell unit prices, and availability. Results paginate after 45 entries. Clicking any result sends its region in chat and starts navigation to its chest, even if it is currently unavailable. Removed shops cannot be selected.

Guidance

The private boss bar displays a direction relative to where the player faces and a horizontal distance to the current target. It points directly toward a property or chest shop; it does not claim a collision-free walking path. When a useful bus itinerary exists, it instead leads to the boarding stop, names each bus and exit stop in chat, tracks bus rides and transfers, then resumes direct walking. The bus planner estimates trip cost from stop distances and recommends buses only for longer journeys where they improve the route. Players board a stopped NPC bus by right-clicking its body or seat and leave by sneaking. Fire's heat boss bar hides navigation until the heat bar clears.

Navigation operates on the server thread, samples only loaded shop inventories, and never loads a shop chunk merely for search. Prices and stock can change between opening the GUI and arrival.

Configuration and customizable messages

Navigation now creates and preserves its own plugins/MCSkylines-Navigation/config.yml and messages.yml. Missing defaults are merged without replacing customized settings. /navigate reload (or /nav reload) requires and reloads both files, ending active guidance so the new timings apply. Invalid settings are rejected without replacing the live settings. Existing use/find permissions and commands are unchanged.

Configuration includes arrival-radius, hud.update-ticks, hud.color, hud.progress-distance, transit.enabled, transit.minimum-trip-distance, transit.maximum-transfer-walk, and boarding/exit/transfer radii. messages.yml covers command feedback, navigation phases, itinerary notices, shop GUI titles/lore and HUD text. Messages accept MiniMessage formatting and plain-text {name} placeholders; hud also accepts the trusted <phase> component. Shared suite pagination arrows retain their standard presentation.

Search results and travel limits

Search normalizes case, spaces, underscores and hyphens; configured custom item names come from the real shop template. Results group at the most specific registered Property region, with outside-property shops as separate results. BUY sorts cheapest player purchase, SELL highest player sale. BOTH compares buy first and prefers available buy then sell for navigation. A red result is unavailable/full; gray means unloaded stock is unknown, not empty. A price can still be shown for an unavailable shop. Clicking starts travel even if stock is unavailable, so recheck on arrival.

Guidance is a direction and horizontal distance, not an obstacle-free path. It does not change worlds or teleport. A useful transit itinerary leads to a boarding stop, tracks rides/transfers and resumes walking; no useful bus route gives direct guidance. Fire heat HUD temporarily takes priority.

Reading command syntax

Configuration defaults: Values shown for operator-configurable settings are the bundled defaults, and can be changed in the module’s configuration or definitions. The server’s active settings take precedence, so costs, speeds, ranges, durations, chances, effects, recipes, limits and enabled features may differ. Command examples illustrate syntax; fixed mechanics and validation bounds are not configuration defaults.

<argument> is required; [argument] is optional. Replace the placeholder, including its brackets, with your value. Choices separated by a vertical bar mean choose one. ... accepts the remaining words. Do not type quotation marks around multiword names unless the command specifically requires them. A bare command has no required arguments. Examples use sample players/IDs: substitute entries from your server and use Tab for configured IDs.

player means a username; operational actions usually require that player online. amount and price are currency values such as 25.00, unless the row specifies items, levels, or units. reason, memo, message, name, and statement accept text where supported. duration uses the module's duration format (for example 10m, 2h, or 7d); it is not a bare number of minutes unless stated. id is the exact identifier displayed by that system, not its friendly name. Permissions and ownership/state/location checks both apply.

Navigation commands

SyntaxArguments / actionPermission
/navigate <region>Registered Property ID in current world
/navigate <world:region>Explicit property reference; world must still equal your current world
/navigate stopEnd guidance
/navigate reloadValidate config/messages, ending active guidance; console allowed
/find [buy or sell or both] [item query...]Open matching shop list; custom name/material query, default BOTH; omitted query searches the exact held item; player

/nav aliases navigate. Example: /find buy iron ingot; /navigate world:hospital. BUY/SELL are from the visitor's perspective. Bare navigate prints instructions. Bare find, or /find buy, searches the exact held item's identity; an empty hand with no query prints instructions.

Root commands and aliases

These are the registered command entry points. The subcommand tables above describe their complete operations. Alias names use the same arguments as their root.

SyntaxPurposePermission / aliases
/navigate <region|world:region|stop|reload>Navigate to a property, stop guidance, or reload settings as an admin.; aliases: /nav
/find [buy|sell|both] [item name]Search chest shops by held item or item name.

03

Registered entry points

Command roots

Use the command syntax sections above for every required argument and subcommand. The short usage below is the plugin’s registered help text.

CommandUsageDescriptionPermission
/navigateAliases: nav/navigate <region|world:region|stop|reload>Navigate to a property, stop guidance, or reload settings as an admin.
/find/find [buy|sell|both] [item name]Search chest shops by held item or item name.

04

LuckPerms reference

Permissions

NodeDefaultDescription / children
trueNo additional description.
trueNo additional description.
opNo additional description.Includes ,
Next pluginMCSkylines-Agriculture

Command and permission references reflect the current plugin.yml manifests in this workspace.