Difference between revisions of "Modding:Index"

Revision as of 17:42, 3 January 2021

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

Looking for something specific? Try searching the Modding namespace.

Creating SMAPI mods
How to create SMAPI mods, with tutorials and documentation. This includes the full SMAPI API + event reference.

Creating content packs
How to create content packs for frameworks like Content Patcher.

Translating mods
How to contribute mod translations for any language supported by the game. (And for modders, how to enable and request translations.)

Advanced topics

SMAPI API reference (also on the sidebar in the "Creating SMAPI mods" guide above)
Common tasks (SMAPI mods)
Specific Examples (SMAPI mods)
Editing XNB files
IDE reference

NPCs:
- Overview
- Dialogue
- Events
- Gift tastes
- Quests
- Schedules

Object data:
- Craftable items
- Crops
- Furniture
- Hats
- Objects
- Weapons

Object metadata:
- Context tags

Other:
- Animals
- Achievements
- Blueprints
- Bundles
- Debug commands
- Farmer sprite
- Festivals
- Fish
- Fish Ponds
- Locations
- Maps
- Mail
- Monsters
- Recipes
- Special orders
- Weather

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
Harmony 2.0	TBD

@@ Line 18: / Line 18: @@
 |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;"| <big>'''[[Modding:Content Patcher|Creating Content Patcher packs]]'''</big><br />How to create content packs for Content Patcher, including links to more info.
+|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;"| <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.)
@@ Line 26: / Line 26: @@
 * [[Modding:Community|Join the community]]
 * [[Modding:Open source|Open source]]
-===Framework mods===
-Some of the known framework mods are listed below, along with their capabilities. The framework mods are written in C#, so you can make content packs for them without needing to know coding yourself. They are available on Nexus Mods.
-'''Content Patcher (CP)''' | [https://www.nexusmods.com/stardewvalley/mods/1915/ CP Nexus Mods page]
-* Edit or replace literally any game file in the [[Modding:Player Guide/Getting Started#Find your game folder|game's <tt>Content</tt> folder]].
-* Add new files, alter images, data, and maps
-* Send the player basic mail
-* Create entire NPCs
-* Make changes dynamic, conditional, seasonal, and/or configurable
-'''Content Patcher Animations (CP-A)''' | [https://www.nexusmods.com/stardewvalley/mods/3853/ CP-A Nexus Mods page]
-* Images patched in with CP can be animated
-'''Json Assets (JA)''' | [https://www.nexusmods.com/stardewvalley/mods/1720/ JA Nexus Mods page]
-* Create new objects, Big Craftables (placeable, machine-sized), crops, fruit trees, hats, weapons, shirts, pants, and boots
-* Specify crafting, cooking, and tailor recipes for new items
-* Specify gift tastes for new items
-* New item data and images can also be targeted with CP
-'''Producer Framework Mod (PFM)''' | [https://www.nexusmods.com/stardewvalley/mods/4970/ PFM Nexus Mods page]
-* Change the inputs, outputs, and behavior of vanilla machines
-* Take new machine Big Craftables (created with JA) and make them work
-'''Custom Furniture (CF)''' | [https://www.nexusmods.com/stardewvalley/mods/1254/ CF Nexus Mods page]
-* Make new items that behave as furniture (e.g. rotatable, or placeable on walls)
-'''TMXL (and PyTK)''' | [https://www.nexusmods.com/stardewvalley/mods/1820/ TMXL Nexus Mods page] | [https://www.nexusmods.com/stardewvalley/mods/1726/ PyTK Nexus Mods page]  | [https://gist.github.com/hatrat/6339a7975ae5d13802488d88a8b10a64#file-wip-passive-features-md Additional PyTK documentation]
-* Necessary to add new map locations
-* Tons of map features like crop layers and water color
-* Can use high resolution textures anywhere, even unrelated to maps
-* Extreme custom tile actions and Lua scripting
-'''Farm Type Manager (FTM)''' | [https://www.nexusmods.com/stardewvalley/mods/3231/ FTM Nexus Mods page]
-* Spawn stumps, debris, forage, ores, meteors, etc.
-* Spawn monsters and create new monster types based on existing ones
-'''Custom Ore Nodes (CON)''' | [https://www.nexusmods.com/stardewvalley/mods/5966/ CON Nexus Mods page]
-* Make new types of rocks you can break to get items, either custom or from the base game
-'''Custom Resource Clumps (CRC)''' | [https://www.nexusmods.com/stardewvalley/mods/6669 CRC Nexus Mods page]
-* Make new types of boulder-sized resource clumps you can break to get items, either custom or from the base game
-'''Shop Tile Framework (STF)''' | [https://www.nexusmods.com/stardewvalley/mods/5005/ STF Nexus Mods page]
-* Add to or change what's for sale in base game shops with a wide variety of conditions
-* Create new shops with a wide variety of conditions
-'''Mail Framework Mod (MFM)''' | [https://www.nexusmods.com/stardewvalley/mods/1536/ MFM Nexus Mods page]
-* Additional mail features (CP can already do basic mail)
-* Custom backgrounds, repeat mail, wider variety of mail attachments, and the ability add multiple attachments to mail
-'''Train Station (TS)''' | [https://www.nexusmods.com/stardewvalley/mods/6183/ TS Nexus Mods page]
-* Make new locations accessible without patching vanilla maps
-'''Custom Music (CM)''' | [https://www.nexusmods.com/stardewvalley/mods/3043/ CM Nexus Mods page]
-* Replace or add new music tracks and sound effects
 ===Advanced topics===

Difference between revisions of "Modding:Index"

Revision as of 17:42, 3 January 2021

Contents

Using mods

Creating mods

Advanced topics

Migration guides

See also

Navigation menu

Search