Skip to content

Latest commit

 

History

History
 
 

NPCMapLocations

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

NPC Map Locations is a Stardew Valley mod which shows the locations of NPC and farmers on the map page and on a minimap, and makes the map positioning much more accurate to the game.

Install

  1. Install the latest version of SMAPI.
  2. Install this mod from Nexus Mods.
  3. Run the game using SMAPI.

Use

For players

Open the in-game map to see the positions for all NPCs, horses, players, and buildings. The map is redrawn to match the in-game layout and positioning much more closely, and the player position will also be much more accurate. The map will change for each season automatically, and adjusts tracking automatically for larger custom map sizes. The map supports custom NPC outfits automatically.

While the map is open, press TAB (or Y on a controller) to show the mod options. You can show/hide characters automatically based on various criteria (e.g. after they're talked to, when in same location, within a certain distance, quests and/or birthdays, etc).

You can optionally enable a minimap. You can move it by holding CTRL + right-click on the minimap, then dragging it to the new position.

For mod authors

See the author guide for more info.

Configure

Global settings

The mod creates a config/global.json file in its mod folder the first time you run it, and a separate file for each save. You can open those files in a text editor to configure the mod.

These are the available settings (most configurable through the in-game menu except the key bindings):

setting what it affects
NameTooltipMode The tooltip position when pointing at something on the map. You can cycle this in-game using the TooltipKey option below. Default 1.
ImmersionOption Which NPCs to display. The possible values are 1 (all villagers), 2 (villagers player has talked to), and 3 (villagers player has not talked to). Default 1.
ByHeartLevel
HeartLevelMin
HeartLevelMax
Whether to only show villagers whose hearts with the player is between HeartLevelMin and HeartLevelMax. Default false, 0, and 12.
OnlySameLocation Whether to only show villagers in the same location as the player. Default false.
MarkQuests Whether to mark NPCs with quests or birthdays today. Default true.
ShowChildren Whether to show player children on the map. Default false.
ShowFarmBuildings Whether to show farm buildings on the map. Default true.
ShowHiddenVillagers Whether to show villagers that would normally be hidden. Default false.
ShowHorse Whether to show horses on the map. Default false.
ShowTravelingMerchant Whether to show the Traveling Merchant when she's in the forest. Default true.
NpcBlacklist The list of NPCs that should be hidden. Default empty.
UseSeasonalMaps Whether to show seasonal variations of the map. Default true.
UseDetailedIsland Whether to replace the stylized Ginger Island in the bottom-right corner of the map with a more detailed and accurate map. Default false.
ShowMinimap Whether to show the floating minimap. Default false.
MinimapX
MinimapY
MinimapWidth
MinimapHeight
The minimap's pixel position and size on screen, if it's enabled. Default x=12, y=12, width=75, height=45.
MinimapExclusions Location names in which the minimap should be disabled. Default empty.
NpcExclusions NPC names to hide from the map. default empty.
NpcMarkerOffsets Custom offsets when drawing vanilla NPCs. You generally shouldn't change this.
MenuKey The key binding to open the options menu when on the map view. Default "Tab".
TooltipKey The key binding to cycle the tooltip position when on the map view. Default "Space".
MinimapToggleKey The key binding to toggle the floating minimap. Default "OemPipe" (i.e. the `

FAQs

  • Why do I see duplicate villagers on the map with UI Info Suite or Foxyfficiency?
    UI Info Suite and Foxyfficiency have a feature to show villagers, and as a result having it installed along with this mod will show duplicate villagers. To continue using this mod, there are options in UI Info Suite and Foxyfficiency to disable just the NPC tracking (look at the respective mod pages for more info).

  • Why does the game freeze or show a black screen on Linux/macOS?
    You can update or reinstall Mono to fix that. Mono is a SMAPI prerequisite on Linux/macOS.

  • Does the redrawn map work with map recolors?
    Yep, the mod has compatibility patches included for most of the popular recolors.

  • Does the mod support custom locations/NPCs?
    Yes, but the mod adding the custom locations/NPCs needs to tell NPC Map Locations how to handle them. See the author guide for more info.

Compatibility

Compatible with Stardew Valley 1.5+ on Linux/macOS/Windows, both single-player and multiplayer. The mod is compatible with lots of NPC/map mods with futureproofing.

In multiplayer, the mod will only work if the host player has it installed.

See also