Difference between revisions of "Modding:Index"
Pathoschild (talk | contribs) (→Advanced topics: fix broken link) |
Pathoschild (talk | contribs) (→Migration guides: + 1.6.9 migration guide) |
||
(39 intermediate revisions by 9 users not shown) | |||
Line 12: | Line 12: | ||
==Creating mods== | ==Creating mods== | ||
+ | |||
+ | Making mods can be broadly divided into two categories: C# mods and content packs (formatted text files that rely on a framework C# mod). Content packs can make new NPCs, edit maps, add new items, add shops, and more, while C# mods can change fundamental game mechanics. Usually it’s easiest to start with making content packs, since you don't need to learn how to program in C#. 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]]. | ||
+ | |||
{| | {| | ||
|- | |- | ||
− | |style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| <span style="font-size: larger;">'''[[Modding: | + | |style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| <span style="font-size: larger;">'''[[Modding:Content pack frameworks|Creating content mods with JSON]]'''</span><br />How to create content packs for frameworks like Content Patcher. |
|- | |- | ||
− | |style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| <span style="font-size: larger;">'''[[Modding: | + | |style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| <span style="font-size: larger;">'''[[Modding:Modder Guide/Get Started|Creating SMAPI mods with C#]]'''</span><br />How to create SMAPI mods, with tutorials and documentation. This includes the full SMAPI API + event reference. |
|- | |- | ||
|style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| <span style="font-size: larger;">'''[[Modding:Translations|Translating mods]]'''</span><br />How to contribute mod translations for any language supported by the game. (And for modders, how to enable and request translations.) | |style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| <span style="font-size: larger;">'''[[Modding:Translations|Translating mods]]'''</span><br />How to contribute mod translations for any language supported by the game. (And for modders, how to enable and request translations.) | ||
Line 26: | Line 29: | ||
* [[Modding:Open source|Open source]] | * [[Modding:Open source|Open source]] | ||
− | === | + | ===Specific topics=== |
* '''[[Modding:Modder Guide/APIs|SMAPI API reference]]''' (also on the sidebar in the "Creating SMAPI mods" guide above) | * '''[[Modding:Modder Guide/APIs|SMAPI API reference]]''' (also on the sidebar in the "Creating SMAPI mods" guide above) | ||
− | * '''[https://stardewmodding. | + | * '''[https://stardewmodding.wiki.gg Modding tutorials wiki]''' |
* [[Modding:Common tasks|Common tasks (SMAPI mods)]] | * [[Modding:Common tasks|Common tasks (SMAPI mods)]] | ||
− | |||
* [[Modding:Editing XNB files|Editing XNB files]] | * [[Modding:Editing XNB files|Editing XNB files]] | ||
* [[Modding:IDE reference|IDE reference]] | * [[Modding:IDE reference|IDE reference]] | ||
* Game: | * Game: | ||
+ | ** [[Modding:Modder Guide/Game Fundamentals|Game fundamentals]] | ||
+ | ** [[Modding:Achievement data|Achievements]] | ||
** [[Modding:Audio|Audio]] | ** [[Modding:Audio|Audio]] | ||
** [[Modding:Custom languages|Custom languages]] | ** [[Modding:Custom languages|Custom languages]] | ||
** [[Modding:Console commands|Console commands]] | ** [[Modding:Console commands|Console commands]] | ||
+ | ** [[Modding:World map|World map]] | ||
+ | ** [[Modding:Game state queries|Game state queries]] | ||
+ | ** [[Modding:Trigger actions|Trigger actions]] | ||
+ | ** [[Modding:Tokenizable strings|Tokenizable strings]] | ||
* NPCs: | * NPCs: | ||
Line 51: | Line 59: | ||
** [[Modding:Crop data|Crops]] | ** [[Modding:Crop data|Crops]] | ||
** [[Modding:Fruit trees|Fruit trees]] | ** [[Modding:Fruit trees|Fruit trees]] | ||
+ | ** [[Modding:Item queries|Item queries]] | ||
+ | ** [[Modding:Machines|Machines]] | ||
+ | ** [[Modding:Recipe data|Recipes]] | ||
+ | ** [[Modding:Wild trees|Wild trees]] | ||
+ | |||
+ | * Locations and maps: | ||
+ | ** [[Modding:Maps|Maps]] | ||
+ | ** [[Modding:Farm data|Farm data]] | ||
+ | ** [[Modding:Festival data|Festivals]] | ||
+ | ** [[Modding:Fish data|Fish]] | ||
+ | ** [[Modding:Location data|Locations]] | ||
+ | ** [[Modding:Movie theater data|Movie theater]] | ||
+ | ** [[Modding:Museum|Museum data]] | ||
+ | ** [[Modding:Weather data|Weather]] | ||
* Other content: | * Other content: | ||
− | |||
− | |||
** [[Modding:Blueprint data|Blueprints]] | ** [[Modding:Blueprint data|Blueprints]] | ||
** [[Modding:Bundles|Bundles]] | ** [[Modding:Bundles|Bundles]] | ||
** [[Modding:Farmer sprite|Farmer sprite]] | ** [[Modding:Farmer sprite|Farmer sprite]] | ||
− | ** [[Modding: | + | ** [[Modding:Fences|Fences]] |
− | ** [[Modding: | + | ** [[Modding:Floors and Paths|Floors and Paths]] |
** [[Modding:Fish Pond data|Fish Ponds]] | ** [[Modding:Fish Pond data|Fish Ponds]] | ||
− | |||
− | |||
** [[Modding:Mail data|Mail]] | ** [[Modding:Mail data|Mail]] | ||
+ | ** [[Modding:Shops|Shops]] | ||
+ | ** [[Modding:Special orders|Special orders]] | ||
+ | |||
+ | * Other entities: | ||
+ | ** [[Modding:Animal data|Animals]] | ||
** [[Modding:Monster data|Monsters]] | ** [[Modding:Monster data|Monsters]] | ||
− | ** [[Modding: | + | ** [[Modding:Pets|Pets]] |
− | + | ||
− | * | + | * Specialized (normally linked from other pages): |
− | ** [[Modding: | + | ** [[Modding:Common data field types|Common data field types]] |
===Migration guides=== | ===Migration guides=== | ||
Line 95: | Line 118: | ||
|- | |- | ||
| [[Modding:Migrate to Stardew Valley 1.5.5|Stardew Valley 1.5.5]] || November 2021 | | [[Modding:Migrate to Stardew Valley 1.5.5|Stardew Valley 1.5.5]] || November 2021 | ||
+ | |- | ||
+ | | [[Modding:Migrate to SMAPI 4.0|SMAPI 4.0]] || March 2024 | ||
+ | |- | ||
+ | | [[Modding:Migrate to Stardew Valley 1.6|Stardew Valley 1.6]] || March 2024 | ||
+ | |- | ||
+ | | [[Modding:Migrate to Stardew Valley 1.6.9|Stardew Valley 1.6.9]] || TBD | ||
|} | |} | ||
Line 104: | Line 133: | ||
* Content pack resources: | * Content pack resources: | ||
** [https://docs.google.com/spreadsheets/d/1CpDrw23peQiq-C7F2FjYOMePaYe0Rc9BwQsj3h6sjyo The great ID spreadsheet] | ** [https://docs.google.com/spreadsheets/d/1CpDrw23peQiq-C7F2FjYOMePaYe0Rc9BwQsj3h6sjyo The great ID spreadsheet] | ||
− | ** [https://stardewmodding.wiki/wiki/Custom_NPC_Tiles Custom NPC festival tile positions] | + | ** [https://stardewmodding.wiki.gg/wiki/Custom_NPC_Tiles Custom NPC festival tile positions] |
* Useful tools: | * Useful tools: | ||
** [https://smapi.io/mods SMAPI mod compatibility list] ([[Modding:Mod compatibility|you can edit it!]]) | ** [https://smapi.io/mods SMAPI mod compatibility list] ([[Modding:Mod compatibility|you can edit it!]]) | ||
Line 111: | Line 140: | ||
* [[User:Kdau#Notes on Android SMAPI modding|Kdau's notes on Android SMAPI modding]] | * [[User:Kdau#Notes on Android SMAPI modding|Kdau's notes on Android SMAPI modding]] | ||
* [[User:Dem1se#Getting_Started_with_Making_UIs| Dem1se's getting started guide on mod UIs]] | * [[User:Dem1se#Getting_Started_with_Making_UIs| Dem1se's getting started guide on mod UIs]] | ||
+ | |||
[[Category:Modding| ]] | [[Category:Modding| ]] | ||
[[de:Modding:Index]] | [[de:Modding:Index]] | ||
[[es:Modding:Índice]] | [[es:Modding:Índice]] | ||
+ | [[fr:Modding:Index]] | ||
[[pt:Modificações:Índice]] | [[pt:Modificações:Índice]] | ||
[[ru:Модификации:Индекс]] | [[ru:Модификации:Индекс]] | ||
+ | [[tr:Modlama:İndeks]] | ||
[[zh:使用模组:目录]] | [[zh:使用模组:目录]] |
Revision as of 17:56, 24 July 2024
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: C# mods and content packs (formatted text files that rely on a framework C# mod). Content packs can make new NPCs, edit maps, add new items, add shops, and more, while C# mods can change fundamental game mechanics. Usually it’s easiest to start with making content packs, since you don't need to learn how to program in C#. 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 JSON 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
Specific 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:
- Item data:
- Locations and maps:
- Other content:
- Specialized (normally linked from other pages):
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 | March 2024 |
Stardew Valley 1.6 | March 2024 |
Stardew Valley 1.6.9 | TBD |
See also
- Pixel art resources:
- Content pack resources:
- Useful tools:
- Kdau's notes on Android SMAPI modding
- Dem1se's getting started guide on mod UIs