makinday / stardew-valley-mods

My mods for Stardew Valley

This repository contains my SMAPI mods for Stardew Valley. See the individual mods for documentation and release notes.

Mods

• NPC Map Locations (Nexus | source)
  Shows character locations on the map. Uses a modified map page much more accurate to the game.
• Location Compass (Nexus | source)
  Locates characters on the screen indicating direction and distance from player's current position.
• Pet Dogs Mod (Nexus | source)
  Replaces the pet dog with a Shiba Inu, Shepherd, or Husky.

Translating the mods

The mods can be translated into any language supported by the game, and SMAPI will automatically use the right translations.

Contributions are welcome! See Modding:Translations on the wiki for help contributing translations.

(❑ = untranslated, ↻ = partly translated, ✓ = fully translated)

	Bouhm's Pet Dogs	NPC Map Locations
Chinese	❑	✓
French	✓	✓
German	✓	✓
Hungarian	❑	✓
Italian	❑	↻
Japanese	❑	↻
Korean	❑	↻
Polish	✓	✓
Portuguese	✓	✓
Russian	❑	↻
Spanish	❑	✓
Thai	✓	✓
Turkish	❑	✓
Ukrainian	✓	✓

Compiling the mods

Installing stable releases from Nexus Mods is recommended for most users. If you really want to compile the mod yourself, read on.

These mods use the crossplatform build config so they can be built on Linux, Mac, and Windows without changes. See the build config documentation for troubleshooting.

Compiling a mod for testing

To compile a mod and add it to your game's Mods directory:

1. Rebuild the project in Visual Studio or MonoDevelop.
   This will compile the code and package it into the mod directory.
2. Launch the project with debugging.
   This will start the game through SMAPI and attach the Visual Studio debugger.

Compiling a mod for release

To package a mod for release:

1. Switch to Release build configuration.
2. Recompile the mod per the previous section.
3. Upload the generated bin/Release/<mod name>-<version>.zip file from the project folder.