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.

Main guides

Player's guide to using mods How to install SMAPI, use mods, and troubleshoot them. Includes the compatibility list.

Modder's guide to SMAPI 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.)

Search

Looking for something specific? Try searching the Modding namespace.

Advanced topics

For players

• Using XNB mods (not recommended)

For mod creators

• IDE reference

• What Programs to Use
• Creating a new mod project
• NuGet Packages
• Editing existing files

• Editing XNB files

• What are XNB Files
• Unpacking & Packing
• Making Changes to XNB Files

• Common tasks (SMAPI Mods)

• Tracking Changes to a Value
• Create an Item (Object)
• Locations
• Player
• NPC (See Custom NPCs below)
• UI
• Menus
• Harmony
• Misc. Common Tasks

• How to Edit Maps
• Custom NPCs:
  • Overview
  • Dialogue
  • Events
  • Gift tastes
  • Schedules

• Objects:
  • Craftable items
  • Crops
  • Furniture
  • Hats
  • Objects

• Other:
  • Animals
  • Achievements
  • Blueprints
  • Bundles
  • Debug commands
  • Farmer sprite
  • Fish
  • Weather

Migration guides

• Migrate to SMAPI 2.0 (October 2017)
• Migrate to Stardew Valley 1.3 (May 2018)
• Migrate to Stardew Valley 1.3 (XNB changes) (May 2018)
• Migrate to SMAPI 3.0 (Q1 2019)

See also

• Chat on Discord — get help, ask questions, or discuss with modders and SMAPI developers.