shi974/stardewvalleymods

New home for my stardew valley mod source code

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

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)

	Chinese	French	German	Hungarian	Italian	Japanese	Korean	Polish	Portuguese	Russian	Spanish	Thai	Turkish	Ukrainian
Animal Social Menu	❑	✓	❑	✓	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Another Hunger Mod	❑	❑	❑	❑	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓
Better Shop Menu	❑	❑	❑	↻	❑	❑	↻	❑	❑	❑	↻	↻	❑	✓
Bug Net	✓	❑	✓	✓	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Capstone Professions	✓	❑	❑	✓	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Combat Level Damage Scaler	❑	❑	❑	❑	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Cooking Skill	❑	✓	✓	✓	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Custom_Crops	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	✓
Displays	✓	✓	✓	❑	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Dynamic Game Assets	❑ ❑	❑ ❑	↻ ❑	↻ ❑	❑ ❑	❑ ❑	↻ ❑	❑ ❑	❑ ❑	❑ ❑	↻ ↻	↻ ❑	❑ ❑	✓ ✓
Experience Bars	❑	❑	✓	✓	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Extended Reach	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	✓	❑	❑	✓
Flower Rain	❑	❑	❑	✓	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓
Generic Mod Config Menu	↻	❑	✓	✓	❑	❑	✓	✓	❑	↻	✓	↻	❑	✓
Hybrid Crop Engine	❑ ❑	❑ ❑	❑ ❑	✓ ✓	❑ ❑	❑ ❑	✓ ❑	❑ ❑	❑ ❑	❑ ❑	✓ ✓	✓ ❑	❑ ❑	✓ ✓
Jump Over	❑	✓	❑	❑	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Junimos Accept Cash	❑	✓	❑	❑	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Luck Skill	❑	✓	✓	✓	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓
Magic	↻	❑	✓	❑	❑	❑	↻	❑	↻	↻	✓	❑	❑	✓
Misapplied Physicalities	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	✓ ✓
Moon Misadventures	❑ ❑	❑ ❑	✓ ✓	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	✓ ❑	❑ ❑	❑ ❑	✓ ✓
More Buildings	❑	❑	❑	✓	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
More Rings	↻	❑	✓	✓	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓
New Game Plus	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	❑	✓
Object Time Left	❑	❑	❑	✓	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Picture Portraits	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	❑ ❑	✓ ✓	✓ ✓	❑ ❑	✓ ✓
Preexisting Relationship	✓	❑	❑	❑	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Realtime Minimap	❑	❑	❑	❑	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓
Rush Orders	❑	❑	❑	❑	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓
Sleepy Eye	❑	❑	❑	❑	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
SpaceCore	❑	❑	✓	✓	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓
Statue of Generosity	❑	✓	❑	❑	❑	❑	✓	❑	❑	❑	✓	✓	❑	✓
Surfing Festival	↻ ✓	❑ ❑	❑ ❑	✓ ✓	❑ ❑	❑ ❑	✓ ✓	❑ ❑	↻ ✓	↻ ✓	✓ ✓	❑ ❑	❑ ❑	✓ ✓
Theft of the Winter Star	❑	❑	❑	✓	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓
Three-Heart Dance Partner	❑	❑	❑	❑	❑	❑	✓	❑	❑	❑	✓	❑	❑	✓

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, macOS, 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 solution in Visual Studio or MonoDevelop.
   This will compile the code and package it into the Mods directory.
2. Launch any 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 mods per the previous section.
3. Upload the generated bin/Release/<mod name>-<version>.zip file from the project folder.

Release order

This order avoids releasing mod updates which need an unreleased update (e.g. updating Json Assets before a SpaceCore update it needs).

Release phases:
      I: non-frameworks with no spacechase dependency
      II: framework mods
      III: mods which use phase II frameworks
      IV: mods which need custom packaging

phase |    mod
----- | ------------------------------
I     | 1.  Better Meteorites
      | 2.  Better Shop Menu
      | 3.  Carry Chest
      | 4.  Combat Level Damage Scaler
      | 5.  Console Code
      | 6.  Custom Critters
      | 7.  Custom NPC Fixes
      | 8.  Experience Bars
      | 9.  Extended Reach
      | 10. Flower Color Picker
      | 11. Flower Rain
      | 12. Jump Over
      | 13. Junimos Accept Cash
      | 14. More Giant Crops
      | 15. More Grass Starters
      | 16. MultiFertilizer
      | 17. Object Time Left
      | 18. Profit Calculator
      | 19. Realtime Minimap
      | 20. Rush Orders
      | 21. Spenny
      | 22. Super Hopper
      | 23. Three-Heart Dance Partner
      | 24. Throwable Axe
----- | ------------------------------
II    | 25. Content Patcher Animations
      | 26. Generic Mod Config Menu
      | 27. Hybrid Crop Engine
      | 28. SpaceCore
      | 29. Dynamic Game Assets         * needs SpaceCore
      | 30. Json Assets                 * needs SpaceCore
----- | ------------------------------
III   | 31. Animal Social Menu
      | 32. Another Hunger Mod
      | 33. Bigger Craftables
      | 34. Bug Net
      | 35. Capstone Professions
      | 36. Cooking Skill
      | 37. DGAAutomate
      | 38. Displays
      | 39. Luck Skill
      | 40. Mana Bar
      | 41. Magic                       * needs Mana Bar
      | 42. More Buildings
      | 43. More Rings
      | 44. Preexisting Relationship
      | 45. Pyromancer's Journey
      | 46. Sleepy Eye
      | 47. Statue of Generosity
      | 48. Theft of the Winter Star
----- | ------------------------------
IV    | 49. Surfing Festival