Modding:Index

Mods are packages of files which change Stardew Valley in some way. Mods can add features (like showing NPCs on the map), change game mechanics (like making fences decay more slowly), make cosmetic changes (like making your house look like a hobbit home), and much more.

Using mods

Using mods How to install SMAPI, use mods, and troubleshoot them. Includes the compatibility list.

• Get help or ask question
• Join the community
• Using XNB mods (not recommended)

Creating mods

Making mods can be broadly divided into two categories: SMAPI mods, which use C#, and content packs, which don’t require coding knowledge, just making json files. Usually it’s easiest to start with making content packs, especially if there’s a framework that already does what you want, and in general it's better to use frameworks whenever possible for compatibility reasons. If you're confused and want to look at a picture of what kinds of modding is possible, see Modding:Modder Guide/Get Started/Pictorial Guide.

Creating content mods with jsons How to create content packs for frameworks like Content Patcher.

Creating SMAPI mods with C# How to create SMAPI mods, with tutorials and documentation. This includes the full SMAPI API + event reference.

Translating mods How to contribute mod translations for any language supported by the game. (And for modders, how to enable and request translations.)

• Looking for something specific? Try searching the Modding namespace.
• Get help or ask question
• Join the community
• Open source

Advanced topics

• SMAPI API reference (also on the sidebar in the "Creating SMAPI mods" guide above)
• Modding tutorials wiki
• Common tasks (SMAPI mods)
• Editing XNB files
• IDE reference

• Game:
  • Audio
  • Custom languages
  • Console commands

• NPCs:
  • Overview
  • Dialogue
  • Events
  • Gift tastes
  • Quests
  • Schedules

• Item data:
  • Items
  • Crops
  • Fruit trees

• Other content:
  • Animals
  • Achievements
  • Blueprints
  • Bundles
  • Farmer sprite
  • Festivals
  • Fish
  • Fish Ponds
  • Locations
  • Maps
  • Mail
  • Monsters
  • Movie theater
  • Recipes
  • Special orders
  • Weather

Migration guides

release	date released
SMAPI 2.0	October 2017
Stardew Valley 1.3	May 2018
Stardew Valley 1.3 (XNB changes)	May 2018
Stardew Valley 1.3.36	March 2019
Stardew Valley 1.4	November 2019
SMAPI 3.0	November 2019
Stardew Valley 1.5	December 2020
64-bit on Windows	May 2021
Harmony 2.0	July 2021
Stardew Valley 1.5.5	November 2021
SMAPI 4.0	upcoming
Stardew Valley 1.6	upcoming

See also

• Pixel art resources:
  • Stardew Valley art style guide
  • Pixel art tutorial on Pixel Joint
  • Pixel art guide on Medium
• Content pack resources:
  • The great ID spreadsheet
  • Custom NPC festival tile positions
• Useful tools:
  • SMAPI mod compatibility list (you can edit it!)
  • SMAPI log parser
  • JSON validator
• Kdau's notes on Android SMAPI modding
• Dem1se's getting started guide on mod UIs