navigator

World Navigator is an in-game navigation system that helps you find any location, NPC, mission drop box, event and more, supporting both original and modded content

world navigator

🌍 **Multi-functional interactive in-game navigation system and guide**

World Navigator is like adapting your phone's navigation app or any GPS device to Stardew Valley. It combines efficient algorithms with versatile menus that provide real-time guidance or plain language instructions written on in-game scrap paper.

🎯 Core Functions

NPCs, Quests, Location Search, Customizable Home Points and Points of Interest

• Provides a detailed menu to select villagers, tasks, events and even your home as navigation targets
• Search any location in the Stardew Valley archive (including clickable map)

-Supports **Mod NPCs, Quests, Locations and Events**

• Other modules can add their own points of interest to the POI submenu

🧭 Proactive guidance and written instructions

• **Active Guidance**: Real-time direction indication with optional pointer, line or footprint visual effects
• Prompt signs will appear when reaching transportation points such as teleporters or minecarts.
• Automatically find the shortest path around obstacles*
• **Written Instructions**: Generate waste paper items that can be viewed by right-clicking to provide a simulated experience

🌐 World understanding and movement system

• Comprehensive understanding of the world's transportation methods: walking, minecart, bus, Jiangdao Parrot Express, etc.
• Understand building opening hours, NPC room access rights, and NPC location in the next few hours

-Supports module locations and multiple module travel methods

• Built-in support for Central Station and its content packs

⚙️ Options and Configuration

The World Navigator has its own submenu of options, with options saved in archive files:

• Select home location (default is farmhouse front)
• Select the visual type when active navigation: surrounding arrows, solid lines, footprints
• Customizable destination indicator display
• Configure the world map color of the search submenu
• Set world limits to check or ignore when calculating paths

🔧 Installation instructions

• Install the latest version of SMAPI
• Download this module and extract it to the `Stardew Valley/Mods` folder
• Install other required modules
• Run the game using SMAPI

🎮Menu access method

• Press the B key on the keyboard to open the menu by default
• Supports module integration such as Better Game Menu, Iconic Framework, Star Control, Mobile Phone, etc.

-Controller users can access through the Star Control module

🤝 Mod Compatibility

• Tested with hundreds of popular mods
• Supports most locations added by Content Patcher
• Mod authors can provide data support for the World Navigator
• Multiplayer mode not fully tested yet

🐛 Problem Report

When you encounter problems, please enter `worldnav log` in the SMAPI console and share the log file. Describe in detail the expected behavior and what actually happens.

🎁 Console commands

• `worldnav log` - used when reporting problems
• `worldnav cancel` - Cancel active navigation
• `worldnav menu` - Opens the world navigator menu
• `worldnav schedule` - View NPC schedule data
• `worldnav cat [filter]` - View registered categories and points of interest

*Note: In rare cases, the shortest path across multiple locations may be missed due to some approximate calculations, but the shortest path will always be found within a single location.