Difference between revisions of "Modding:Index"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Specific topics: + common data field types)
(38 intermediate revisions by 9 users not shown)
Line 4: Line 4:
 
{|
 
{|
 
|-
 
|-
−
|style="border: 2px solid rgb(0, 116, 72); background: rgba(3, 160, 7, 0.1); padding: 1em;"| <big>'''[[Modding:Player Guide/Getting Started|Using mods]]'''</big><br />How to install SMAPI, use mods, and troubleshoot them. Includes the compatibility list.
+
|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: 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;"| <big>'''[[Modding:Modder Guide/Get Started|Creating SMAPI mods]]'''</big><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: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;"| <big>'''[[Modding:Content pack frameworks|Creating content packs]]'''</big><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;"| <big>'''[[Modding:Translations|Translating mods]]'''</big><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.)
 
|}
 
|}
  
−
* ''Looking for something specific? Try [{{fullurl:Special:Search|ns570=1}} searching the <tt>Modding</tt> namespace].''
+
* ''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]]
 
* [[Modding:Open source|Open source]]
 
* [[Modding:Open source|Open source]]
  
−
===Advanced topics===
+
===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.wiki Modding tutorials wiki]'''
+
* '''[https://stardewmodding.wiki.gg Modding tutorials wiki]'''
 
* [[Modding:Common tasks|Common tasks (SMAPI mods)]]
 
* [[Modding:Common tasks|Common tasks (SMAPI mods)]]
−
* [[Modding:Specific Examples|Specific Examples (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:Modder Guide/Game Fundamentals|Game fundamentals]]
 +
** [[Modding:Audio|Audio]]
 +
** [[Modding:Custom languages|Custom languages]]
 +
** [[Modding:Console commands|Console commands]]
 +
** {{upcoming|version = 1.6|content = [[Modding:World map|World map]]|inline=1}}
 +
** {{upcoming|version = 1.6|content = [[Modding:Game state queries|Game state queries]]|inline=1}}
 +
** {{upcoming|version = 1.6|content = [[Modding:Item queries|Item queries]]|inline=1}}
 +
** {{upcoming|version = 1.6|content = [[Modding:Trigger actions|Trigger actions]]|inline=1}}
 +
** {{upcoming|version = 1.6|content = [[Modding:Tokenizable strings|Tokenizable strings]]|inline=1}}
 +
** {{upcoming|version = 1.6|content = [[Modding:Shops|Shops]]|inline=1}}
 +
** {{upcoming|version = 1.6|content = [[Modding:Custom Farms|Farm map]]|inline=1}}
  
 
* NPCs:
 
* NPCs:
Line 42: Line 57:
 
** [[Modding:Schedule data|Schedules]]
 
** [[Modding:Schedule data|Schedules]]
  
−
* Object data:
+
* Item data:
−
** [[Modding:Big craftables data|Craftable items]]
+
** [[Modding:Items|Items]]
 
** [[Modding:Crop data|Crops]]
 
** [[Modding:Crop data|Crops]]
−
** [[Modding:Furniture data|Furniture]]
+
** [[Modding:Fruit trees|Fruit trees]]
−
** [[Modding:Hat data|Hats]]
 
−
** [[Modding:Object data|Objects]]
 
−
** [[Modding:Weapon data|Weapons]]
 
  
−
* Object metadata:
+
* Other content:
−
** [[Modding:Context tags|Context tags]]
 
−
 
 
−
* Other:
 
 
** [[Modding:Animal data|Animals]]
 
** [[Modding:Animal data|Animals]]
 
** [[Modding:Achievement data|Achievements]]
 
** [[Modding:Achievement data|Achievements]]
−
** [[Modding:Audio|Audio]]
 
 
** [[Modding:Blueprint data|Blueprints]]
 
** [[Modding:Blueprint data|Blueprints]]
 
** [[Modding:Bundles|Bundles]]
 
** [[Modding:Bundles|Bundles]]
−
** [[Modding:Debug commands|Debug commands]]
 
 
** [[Modding:Farmer sprite|Farmer sprite]]
 
** [[Modding:Farmer sprite|Farmer sprite]]
 
** [[Modding:Festival data|Festivals]]
 
** [[Modding:Festival data|Festivals]]
Line 68: Line 75:
 
** [[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]]
 
** [[Modding:Weather data|Weather]]
 
** [[Modding:Weather data|Weather]]
 +
 +
* Specialized (normally linked from other pages):
 +
** {{upcoming|version = 1.6|content = [[Modding:Common data field types|Common data field types]]|inline=1}}
  
 
===Migration guides===
 
===Migration guides===
Line 96: Line 107:
 
| [[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]] || August 2021 (beta)
+
| [[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''
 
|}
 
|}
  
Line 106: Line 121:
 
* 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 112: Line 127:
 
** [https://smapi.io/json JSON validator]
 
** [https://smapi.io/json JSON validator]
 
* [[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]]
  
 
[[Category:Modding| ]]
 
[[Category:Modding| ]]
Line 117: Line 133:
 
[[de:Modding:Index]]
 
[[de:Modding:Index]]
 
[[es:Modding:Índice]]
 
[[es:Modding:Índice]]
−
[[ko:모드:색인]]
+
[[fr:Modding:Index]]
 
[[pt:Modificações:Índice]]
 
[[pt:Modificações:Índice]]
 
[[ru:Модификации:Индекс]]
 
[[ru:Модификации:Индекс]]
 
[[zh:使用模组:目录]]
 
[[zh:使用模组:目录]]

Revision as of 17:06, 19 February 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 upcoming
Stardew Valley 1.6 upcoming

See also

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