Difference between revisions of "Modding:Index"
Pathoschild (talk | contribs) (→See also: remove Discord link (not easily web accessible), group pixel art resources, rewrite into wiki style) |
(add pictorial guide link) |
||
(21 intermediate revisions by 6 users not shown) | |||
Line 4: | Line 4: | ||
{| | {| | ||
|- | |- | ||
− | |style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| < | + | |style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| <span style="font-size: larger;">'''[[Modding:Player Guide/Getting Started|Using mods]]'''</span><br />How to install SMAPI, use mods, and troubleshoot them. Includes the compatibility list. |
|} | |} | ||
Line 12: | Line 12: | ||
==Creating mods== | ==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]]. | ||
+ | |||
{| | {| | ||
|- | |- | ||
− | |style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| < | + | |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 jsons]]'''</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;"| < | + | |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;"| < | + | |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.) |
|} | |} | ||
− | * ''Looking for something specific? Try [{{fullurl:Special:Search|ns570=1}} searching the < | + | * ''Looking for something specific? Try [{{fullurl:Special:Search|ns570=1}} searching the <samp>Modding</samp> namespace].'' |
* [[Modding:Help|Get help or ask question]] | * [[Modding:Help|Get help or ask question]] | ||
* [[Modding:Community|Join the community]] | * [[Modding:Community|Join the community]] | ||
Line 28: | Line 31: | ||
===Advanced topics=== | ===Advanced 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.miraheze.org 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: | ||
+ | ** [[Modding:Audio|Audio]] | ||
+ | ** [[Modding:Custom languages|Custom languages]] | ||
+ | ** [[Modding:Console commands|Console commands]] | ||
* NPCs: | * NPCs: | ||
Line 42: | Line 49: | ||
** [[Modding:Schedule data|Schedules]] | ** [[Modding:Schedule data|Schedules]] | ||
− | * | + | * Item data: |
− | ** [[Modding: | + | ** [[Modding:Items|Items]] |
** [[Modding:Crop data|Crops]] | ** [[Modding:Crop data|Crops]] | ||
− | ** [[Modding: | + | ** [[Modding:Fruit trees|Fruit trees]] |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | * Other: | + | * Other content: |
** [[Modding:Animal data|Animals]] | ** [[Modding:Animal data|Animals]] | ||
** [[Modding:Achievement data|Achievements]] | ** [[Modding:Achievement data|Achievements]] | ||
** [[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:Festival data|Festivals]] | ** [[Modding:Festival data|Festivals]] | ||
Line 67: | Line 67: | ||
** [[Modding:Mail data|Mail]] | ** [[Modding:Mail data|Mail]] | ||
** [[Modding:Monster data|Monsters]] | ** [[Modding:Monster data|Monsters]] | ||
+ | ** [[Modding:Movie theater data|Movie theater]] | ||
** [[Modding:Recipe data|Recipes]] | ** [[Modding:Recipe data|Recipes]] | ||
** [[Modding:Special orders|Special orders]] | ** [[Modding:Special orders|Special orders]] | ||
Line 95: | Line 96: | ||
| [[Modding:Migrate to Harmony 2.0|Harmony 2.0]] || July 2021 | | [[Modding:Migrate to Harmony 2.0|Harmony 2.0]] || July 2021 | ||
|- | |- | ||
− | | [[Modding:Migrate to Stardew Valley 1.5.5|Stardew Valley 1.5.5]] || | + | | [[Modding:Migrate to Stardew Valley 1.5.5|Stardew Valley 1.5.5]] || November 2021 |
+ | |- | ||
+ | | [[Modding:Migrate to SMAPI 4.0|SMAPI 4.0]] || ''upcoming'' | ||
+ | |- | ||
+ | | [[Modding:Migrate to Stardew Valley 1.6|Stardew Valley 1.6]] || ''upcoming'' | ||
|} | |} | ||
===See also=== | ===See also=== | ||
− | |||
* Pixel art resources: | * Pixel art resources: | ||
** [https://sundrop.kvdk.net/art-guide Stardew Valley art style guide] | ** [https://sundrop.kvdk.net/art-guide Stardew Valley art style guide] | ||
** [https://pixeljoint.com/forum/forum_posts.asp?TID=11299&PID=139322 Pixel art tutorial on Pixel Joint] | ** [https://pixeljoint.com/forum/forum_posts.asp?TID=11299&PID=139322 Pixel art tutorial on Pixel Joint] | ||
** [https://medium.com/pixel-grimoire/how-to-start-making-pixel-art-2d1e31a5ceab Pixel art guide on Medium] | ** [https://medium.com/pixel-grimoire/how-to-start-making-pixel-art-2d1e31a5ceab Pixel art guide on Medium] | ||
+ | * Content pack resources: | ||
+ | ** [https://docs.google.com/spreadsheets/d/1CpDrw23peQiq-C7F2FjYOMePaYe0Rc9BwQsj3h6sjyo The great ID spreadsheet] | ||
+ | ** [https://stardewmodding.miraheze.org/wiki/Custom_NPC_Tiles Custom NPC festival tile positions] | ||
+ | * Useful tools: | ||
+ | ** [https://smapi.io/mods SMAPI mod compatibility list] ([[Modding:Mod compatibility|you can edit it!]]) | ||
+ | ** [https://smapi.io/log SMAPI log parser] | ||
+ | ** [https://smapi.io/json JSON validator] | ||
+ | * [[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]] | ||
[[Category:Modding| ]] | [[Category:Modding| ]] | ||
Line 109: | Line 122: | ||
[[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:Модификации:Индекс]] | ||
[[zh:使用模组:目录]] | [[zh:使用模组:目录]] |
Revision as of 00:49, 20 May 2023
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
- Item data:
- Other content:
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:
- Content pack resources:
- Useful tools:
- Kdau's notes on Android SMAPI modding
- Dem1se's getting started guide on mod UIs