Difference between revisions of "Modding:Index"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Specific topics: tweak organization, update link for farm data)
 
(176 intermediate revisions by 20 users not shown)
Line 1: Line 1:
 
'''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.
 
'''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.
  
−
==For players==
+
==Using mods==
−
* [[Modding:Player FAQs|FAQs]]
+
{|
−
* [[Modding:Installing SMAPI|Install SMAPI]]
+
|-
−
* [[Modding:Updating mods for SMAPI 2.0|Update mods for SMAPI 2.0]]
+
|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.
−
* Need help? [https://discord.gg/kH55QXP Ask on Discord]
+
|}
  
−
==For mod creators==
+
* [[Modding:Help|Get help or ask question]]
−
===SMAPI mods===
+
* [[Modding:Community|Join the community]]
−
* [[Modding:Creating a SMAPI mod|Creating a mod]]
+
* [[Modding:Using XNB mods|Using XNB mods]] (not recommended)
−
* [[Modding:SMAPI APIs|SMAPI reference]]
+
 
−
* [[Modding:Updating deprecated SMAPI code|Updating deprecated code]]
+
==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: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;"| <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.)
 +
|}
 +
 
 +
* ''Looking for something specific? Try [{{fullurl:Special:Search|ns570=1}} searching the <samp>Modding</samp> namespace].''
 +
* [[Modding:Help|Get help or ask question]]
 +
* [[Modding:Community|Join the community]]
 +
* [[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)
 +
* '''[https://stardewmodding.wiki.gg Modding tutorials wiki]'''
 +
* [[Modding:Common tasks|Common tasks (SMAPI mods)]]
 +
* [[Modding:Editing XNB files|Editing XNB files]]
 
* [[Modding:IDE reference|IDE reference]]
 
* [[Modding:IDE reference|IDE reference]]
  
−
===XNB mods===
+
* Game:
−
* [[Modding:Creating an XNB mod|Creating an XNB mod]]
+
** [[Modding:Modder Guide/Game Fundamentals|Game fundamentals]]
 +
** [[Modding:Audio|Audio]]
 +
** [[Modding:Custom languages|Custom languages]]
 +
** [[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]]
  
−
===Advanced topics===
 
−
* [[Modding:Maps|Maps]]
 
 
* NPCs:
 
* NPCs:
 +
** [[Modding:NPC data|Overview]]
 
** [[Modding:Dialogue|Dialogue]]
 
** [[Modding:Dialogue|Dialogue]]
 
** [[Modding:Event data|Events]]
 
** [[Modding:Event data|Events]]
 
** [[Modding:Gift taste data|Gift tastes]]
 
** [[Modding:Gift taste data|Gift tastes]]
 +
** [[Modding:Quest data|Quests]]
 
** [[Modding:Schedule data|Schedules]]
 
** [[Modding:Schedule data|Schedules]]
  
−
* Objects:
+
* Item data:
−
** [[Modding:Big Craftables data|Craftable items]]
+
** [[Modding:Items|Items]]
−
** [[Modding:Furniture data|Furniture]]
+
** [[Modding:Crop data|Crops]]
−
** [[Modding:Hat data|Hats]]
+
** [[Modding:Fruit trees|Fruit trees]]
−
** [[Modding:Object data|Objects]]
+
** [[Modding:Item queries|Item queries]]
 +
** [[Modding:Machines|Machines]]
 +
** [[Modding:Recipe data|Recipes]]
 +
** [[Modding:Shops|Shops]]
 +
 
 +
* Locations and maps:
 +
** [[Modding:Maps|Maps]]
 +
** [[Modding:Farm data|Farm data]]
 +
** [[Modding:Festival data|Festivals]]
 +
** [[Modding:Fish data|Fish]]
 +
** [[Modding:Movie theater data|Movie theater]]
 +
** [[Modding:Weather data|Weather]]
  
−
* Other:
+
* Other content:
 +
** [[Modding:Animal data|Animals]]
 
** [[Modding:Achievement data|Achievements]]
 
** [[Modding:Achievement data|Achievements]]
 
** [[Modding:Blueprint data|Blueprints]]
 
** [[Modding:Blueprint data|Blueprints]]
−
** [[Modding:Debug commands|Debug commands]]
+
** [[Modding:Bundles|Bundles]]
−
** [[Modding:Fish data|Fish]]
+
** [[Modding:Farmer sprite|Farmer sprite]]
−
** [[Modding:Weather data|Weather]]
+
** [[Modding:Fish Pond data|Fish Ponds]]
 +
** [[Modding:Location data|Locations]]
 +
** [[Modding:Mail data|Mail]]
 +
** [[Modding:Monster data|Monsters]]
 +
** [[Modding:Special orders|Special orders]]
 +
 
 +
* Specialized (normally linked from other pages):
 +
** [[Modding:Common data field types|Common data field types]]
 +
 
 +
===Migration guides===
 +
{| class="wikitable"
 +
|-
 +
! release
 +
! date released
 +
|-
 +
| [[Modding:Migrate to SMAPI 2.0|SMAPI 2.0]] || October 2017
 +
|-
 +
| [[Modding:Migrate to Stardew Valley 1.3|Stardew Valley 1.3]] || May 2018
 +
|-
 +
| [[Modding:Migrate XNB changes to Stardew Valley 1.3|Stardew Valley 1.3 (XNB changes)]] || May 2018
 +
|-
 +
| [[Modding:Migrate to Stardew Valley 1.3.36|Stardew Valley 1.3.36]] || March 2019
 +
|-
 +
| [[Modding:Migrate to Stardew Valley 1.4|Stardew Valley 1.4]] || November 2019
 +
|-
 +
| [[Modding:Migrate to SMAPI 3.0|SMAPI 3.0]] || November 2019
 +
|-
 +
| [[Modding:Migrate to Stardew Valley 1.5|Stardew Valley 1.5]] || December 2020
 +
|-
 +
| [[Modding:Migrate to 64-bit on Windows|64-bit on Windows]] || May 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]] || 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
 +
|}
  
 
===See also===
 
===See also===
−
* [https://discord.gg/kH55QXP Chat on Discord] — get help, ask questions, or discuss with modders and SMAPI developers.
+
* Pixel art resources:
 +
** [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://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.wiki.gg/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]]
  
−
[[File:SMAPI mascot.png|20px]]
+
[[Category:Modding| ]]
  
−
[[Category:Modding| ]]
+
[[de:Modding:Index]]
 +
[[es:Modding:Índice]]
 +
[[fr:Modding:Index]]
 +
[[pt:Modificações:Índice]]
 +
[[ru:Модификации:Индекс]]
 +
[[zh:使用模组:目录]]

Latest revision as of 18:14, 6 April 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.

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 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.)

Specific topics

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

See also

Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Index&oldid=164784"