Difference between revisions of "Modding:Content pack frameworks"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Popular frameworks: add Better Farm Animal Variety and Better Artisan Good Icons, remove redundant 'to the game' phrases)
(→‎Popular frameworks: explain what the acronyms are in the intro, tweak acronym format)
Line 6: Line 6:
  
 
==Popular frameworks==
 
==Popular frameworks==
Here are the framework mods used most often to create content packs.
+
Here are the framework mods used most often to create content packs. <small>(The parenthesis next to each name is the [[Modding:Content packs#Conventions|conventional acronym used in the folder name]].)</small>
  
 
===Core (1000+ content packs)===
 
===Core (1000+ content packs)===
Line 14: Line 14:
 
! functionality
 
! functionality
 
|-
 
|-
| {{nexus mod|1915|Content Patcher (CP)}}
+
| {{nexus mod|1915|Content Patcher}} <small>(CP)</small>
 
| Add/edit/replace any content asset in the game (''i.e.,'' assets normally read from [[Modding:Player Guide/Getting Started#Find your game folder|your game's <samp>Content</samp> folder]]). It supports data/image/map files, has functionality like partial patches and prepend/append, and supports many different conditions and tokens (''e.g.,'' to make textures seasonal, data that changes by time of day, etc). A wide variety of mods can be created using Content Patcher, from simple portrait replacements to creating entire NPCs.
 
| Add/edit/replace any content asset in the game (''i.e.,'' assets normally read from [[Modding:Player Guide/Getting Started#Find your game folder|your game's <samp>Content</samp> folder]]). It supports data/image/map files, has functionality like partial patches and prepend/append, and supports many different conditions and tokens (''e.g.,'' to make textures seasonal, data that changes by time of day, etc). A wide variety of mods can be created using Content Patcher, from simple portrait replacements to creating entire NPCs.
  
 
See [[Modding:Content Patcher]] for a getting started guide.
 
See [[Modding:Content Patcher]] for a getting started guide.
 
|-
 
|-
| {{nexus mod|1720|Json Assets (JA)}}
+
| {{nexus mod|1720|Json Assets}} <small>(JA)</small>
 
| Create specific item types, with support for functionality specific to each item type (''e.g.,'' specifying crafting/cooking/recipes or gift tastes for new items). It currently supports creating objects, big craftables, crops, fruit trees, hats, weapons, shirts, pants, and boots. Content and images added by Json Assets can also be edited through Content Patcher.
 
| Create specific item types, with support for functionality specific to each item type (''e.g.,'' specifying crafting/cooking/recipes or gift tastes for new items). It currently supports creating objects, big craftables, crops, fruit trees, hats, weapons, shirts, pants, and boots. Content and images added by Json Assets can also be edited through Content Patcher.
  
Line 31: Line 31:
 
! functionality
 
! functionality
 
|-
 
|-
| {{nexus mod|9246|Alternative Textures (AT)}}
+
| {{nexus mod|9246|Alternative Textures}} <small>(AT)</small>
 
| Enables texture variation for placeable objects, buildings and entities. This includes trees, animals, pets, farm buildings, plants, and more.
 
| Enables texture variation for placeable objects, buildings and entities. This includes trees, animals, pets, farm buildings, plants, and more.
 
|-
 
|-
| {{nexus mod|4970|Producer Framework Mod (PFM)}}
+
| {{nexus mod|4970|Producer Framework Mod}} <small>(PFM)</small>
 
| Add/change the inputs/outputs/behaviour of any machine in the game. That includes vanilla machines (''e.g.,'' [[Keg|keg]]), machines added by other mods, and adding machine logic to any big craftable.
 
| Add/change the inputs/outputs/behaviour of any machine in the game. That includes vanilla machines (''e.g.,'' [[Keg|keg]]), machines added by other mods, and adding machine logic to any big craftable.
 
|}
 
|}
Line 44: Line 44:
 
! functionality
 
! functionality
 
|-
 
|-
| {{nexus mod|2080|Better Artisan Good Icons (BAGI)}}
+
| {{nexus mod|2080|Better Artisan Good Icons}} <small>(BAGI)</small>
 
| Add custom icons to artisanal items like [[honey]] or [[wine]] based on the item or flower used to make them.
 
| Add custom icons to artisanal items like [[honey]] or [[wine]] based on the item or flower used to make them.
 
|-
 
|-
| [https://smapi.io/mods/#Paritee.27s_Better_Farm_Animal_Variety Better Farm Animal Variety (BFAV)]
+
| [https://smapi.io/mods/#Paritee.27s_Better_Farm_Animal_Variety Better Farm Animal Variety] <small>(BFAV)</small>
 
| Add new farm animal types.
 
| Add new farm animal types.
 
|-
 
|-
| {{nexus mod|1254|Custom Furniture (CF)}}
+
| {{nexus mod|1254|Custom Furniture}} <small>(CF)</small>
 
| Add new [[furniture]] items.
 
| Add new [[furniture]] items.
 
|-
 
|-
| {{nexus mod|3043|Custom Music (CM)}}
+
| {{nexus mod|3043|Custom Music}} <small>(CM)</small>
 
| Replace or add music tracks and sound effects.
 
| Replace or add music tracks and sound effects.
 
|-
 
|-
| {{nexus mod|9365|Dynamic Game Assets (DGA)}}
+
| {{nexus mod|9365|Dynamic Game Assets}} <small>(DGA)</small>
 
| Create specific item types, with support for functionality specific to each item type (''e.g.,'' specifying crafting/cooking/recipes or gift tastes for new items). It currently supports creating big craftables, boots, crafting recipes, crops, fences, forge recipes, fruit trees, furniture, hats, machine recipes, melee weapons, objects, gift tastes, pants, shirts, shop entries, tailoring recipes, and texture overrides.
 
| Create specific item types, with support for functionality specific to each item type (''e.g.,'' specifying crafting/cooking/recipes or gift tastes for new items). It currently supports creating big craftables, boots, crafting recipes, crops, fences, forge recipes, fruit trees, furniture, hats, machine recipes, melee weapons, objects, gift tastes, pants, shirts, shop entries, tailoring recipes, and texture overrides.
 
|-
 
|-
| {{nexus mod|3231|Farm Type Manager (FTM)}}
+
| {{nexus mod|3231|Farm Type Manager}} <small>(FTM)</small>
 
| Add farm-like spawning logic to any map. That includes spawning stumps, debris, forage, meteors, monsters, ores, etc.
 
| Add farm-like spawning logic to any map. That includes spawning stumps, debris, forage, meteors, monsters, ores, etc.
 
|-
 
|-
| {{nexus mod|9969|Fashion Sense (FS)}}
+
| {{nexus mod|9969|Fashion Sense}} <small>(FS)</small>
 
| Allows for bigger accessories, hairstyles, hats, shirts, sleeves and pants, as well as animation support and more.
 
| Allows for bigger accessories, hairstyles, hats, shirts, sleeves and pants, as well as animation support and more.
 
|-
 
|-
| {{nexus mod|1536|Mail Framework Mod (MFM)}}
+
| {{nexus mod|1536|Mail Framework Mod}} <small>(MFM)</small>
 
| Add new mail with functionality like custom backgrounds, repeating mail, a wider variety of mail attachments, and support for multiple attachments. (Simple mail without the custom functionality can also be added via Content Patcher.)
 
| Add new mail with functionality like custom backgrounds, repeating mail, a wider variety of mail attachments, and support for multiple attachments. (Simple mail without the custom functionality can also be added via Content Patcher.)
 
|-
 
|-
| {{nexus mod|5005|Shop Tile Framework (STF)}}
+
| {{nexus mod|5005|Shop Tile Framework}} <small>(STF)</small>
 
| Add new shops or edit existing shop inventories with a wide variety of conditions.
 
| Add new shops or edit existing shop inventories with a wide variety of conditions.
 
|-
 
|-
| {{nexus mod|1820|TMXL Map Toolkit (TMXL)}}
+
| {{nexus mod|1820|TMXL Map Toolkit}} <small>(TMXL)</small>
 
| Add/edit in-game locations and maps. It includes a wide variety of specialized map functionality like crop layers, water color, tile actions, and Lua scripting.
 
| Add/edit in-game locations and maps. It includes a wide variety of specialized map functionality like crop layers, water color, tile actions, and Lua scripting.
  
Line 85: Line 85:
 
! functionality
 
! functionality
 
|-
 
|-
| {{nexus mod|3853|Content Patcher Animations (CPA, CP-A)}}
+
| {{nexus mod|3853|Content Patcher Animations}} <small>(CP-A)</small>
 
| Animate any texture loaded through Content Patcher, including for textures that can't normally be animated (''e.g.,'' item sprites).
 
| Animate any texture loaded through Content Patcher, including for textures that can't normally be animated (''e.g.,'' item sprites).
 
|-
 
|-
| {{nexus mod|8626|Custom Companions (CC)}}
+
| {{nexus mod|8626|Custom Companions}} <small>(CC)</small>
 
| Allows creating custom entities that can be spawned on maps or follow the player around. This includes animals in the world or wandering NPCs.
 
| Allows creating custom entities that can be spawned on maps or follow the player around. This includes animals in the world or wandering NPCs.
 
|-
 
|-
| {{nexus mod|6293|Custom Crafting Stations (CCS)}}
+
| {{nexus mod|6293|Custom Crafting Stations}} <small>(CCS)</small>
 
| Add customized crafting stations which opens menus with a limited selection of recipes, without those recipes cluttering up the vanilla crafting menus. The stations can be [https://stardewvalleywiki.com/Modding:Big_craftables_data big craftables] that are vanilla or added using Json Assets (JA). The stations can also be added via tiledata added to the map.
 
| Add customized crafting stations which opens menus with a limited selection of recipes, without those recipes cluttering up the vanilla crafting menus. The stations can be [https://stardewvalleywiki.com/Modding:Big_craftables_data big craftables] that are vanilla or added using Json Assets (JA). The stations can also be added via tiledata added to the map.
 
|-
 
|-
| {{nexus mod|1255|Custom Critters (CC)}}
+
| {{nexus mod|1255|Custom Critters}} <small>(CC)</small>
 
| Add custom critters to the world, like butterflies and bees.
 
| Add custom critters to the world, like butterflies and bees.
 
|-
 
|-
| {{nexus mod|13804|Custom Farm Loader (CFL)}}
+
| {{nexus mod|13804|Custom Farm Loader}} <small>(CFL)</small>
 
| A simplified way of adding custom farms. Supports among other things spawning items/debris/resource clumps/beach drops and setting fishing rules within your farms context.
 
| A simplified way of adding custom farms. Supports among other things spawning items/debris/resource clumps/beach drops and setting fishing rules within your farms context.
 
|-
 
|-
| {{nexus mod|10202|Custom Obelisks (CO)}}
+
| {{nexus mod|10202|Custom Obelisks}} <small>(CO)</small>
 
| Add custom obelisks that let you teleport from the farm to any location, as well as totems.
 
| Add custom obelisks that let you teleport from the farm to any location, as well as totems.
 
|-
 
|-
| {{nexus mod|5966|Custom Ore Nodes (CON)}}
+
| {{nexus mod|5966|Custom Ore Nodes}} <small>(CON)</small>
 
| Add rock/mineral types you can break to get items, either custom or from the base game.
 
| Add rock/mineral types you can break to get items, either custom or from the base game.
 
|-
 
|-
| {{nexus mod|6669|Custom Resource Clumps (CRC)}}
+
| {{nexus mod|6669|Custom Resource Clumps}} <small>(CRC)</small>
 
| Add new types of boulder-sized resource clumps you can break to get items, either custom or from the base game.
 
| Add new types of boulder-sized resource clumps you can break to get items, either custom or from the base game.
 
|-
 
|-
| {{nexus mod|10024|Custom Winter Star Gifts (CWSG)}}
+
| {{nexus mod|10024|Custom Winter Star Gifts}} <small>(CWSG)</small>
 
| Change the gifts people give at the Winter Star festival via a set of many add and replace instructions.
 
| Change the gifts people give at the Winter Star festival via a set of many add and replace instructions.
 
|-
 
|-
| {{nexus mod|7431|Expanded Storage (ES)}}
+
| {{nexus mod|7431|Expanded Storage}} <small>(ES)</small>
 
| Adds custom storages (chests, cabinets, etc.) that support capacity at vanilla levels and beyond.
 
| Adds custom storages (chests, cabinets, etc.) that support capacity at vanilla levels and beyond.
 
|-
 
|-
| {{nexus mod|6414|Quest Framework (QF)}}
+
| {{nexus mod|6414|Quest Framework}} <small>(QF)</small>
 
| Add modders the ability to create custom quests, define custom quest types and handle quests on the back-end.
 
| Add modders the ability to create custom quests, define custom quest types and handle quests on the back-end.
 
|-
 
|-
| {{nexus mod|6183|Train Station (TS)}}
+
| {{nexus mod|6183|Train Station}} <small>(TS)</small>
 
| Make new locations accessible through the [[railroad]] train station, so you don't need to patch paths/warps into existing maps.
 
| Make new locations accessible through the [[railroad]] train station, so you don't need to patch paths/warps into existing maps.
 
|-
 
|-
| {{nexus mod|15132|Unlockable Areas (UA)}}
+
| {{nexus mod|15132|Unlockable Areas}} <small>(UA)</small>
 
| Makes map overlays purchaseable through a interactable shop.
 
| Makes map overlays purchaseable through a interactable shop.
 
|}
 
|}

Revision as of 16:45, 3 June 2023

Content pack frameworks are SMAPI mods which let you write content packs with little or no programming experience, and implement the functionality for you. Content packs are one of the two main ways to mod Stardew Valley, alongside creating C# mods for SMAPI directly. For a pictorial concept map of many of the most popular frameworks, see this page.

Each framework mod defines their own content pack format; see their mod pages for usage.

Here's a list of software for pixel art and JSON text editors we recommend. With software like VS Code and Sublime, you can set up the schema so it checks the formatting of your JSON file as you write your mod. In that way, it's like a built in json validator site. More details on setting up the schema here.

Popular frameworks

Here are the framework mods used most often to create content packs. (The parenthesis next to each name is the conventional acronym used in the folder name.)

Core (1000+ content packs)

mod functionality
Content Patcher (CP) Add/edit/replace any content asset in the game (i.e., assets normally read from your game's Content folder). It supports data/image/map files, has functionality like partial patches and prepend/append, and supports many different conditions and tokens (e.g., to make textures seasonal, data that changes by time of day, etc). A wide variety of mods can be created using Content Patcher, from simple portrait replacements to creating entire NPCs.

See Modding:Content Patcher for a getting started guide.

Json Assets (JA) Create specific item types, with support for functionality specific to each item type (e.g., specifying crafting/cooking/recipes or gift tastes for new items). It currently supports creating objects, big craftables, crops, fruit trees, hats, weapons, shirts, pants, and boots. Content and images added by Json Assets can also be edited through Content Patcher.

See its GitHub readme for documentation.

Popular (400+)

mod functionality
Alternative Textures (AT) Enables texture variation for placeable objects, buildings and entities. This includes trees, animals, pets, farm buildings, plants, and more.
Producer Framework Mod (PFM) Add/change the inputs/outputs/behaviour of any machine in the game. That includes vanilla machines (e.g., keg), machines added by other mods, and adding machine logic to any big craftable.

Common (100+)

mod functionality
Better Artisan Good Icons (BAGI) Add custom icons to artisanal items like honey or wine based on the item or flower used to make them.
Better Farm Animal Variety (BFAV) Add new farm animal types.
Custom Furniture (CF) Add new furniture items.
Custom Music (CM) Replace or add music tracks and sound effects.
Dynamic Game Assets (DGA) Create specific item types, with support for functionality specific to each item type (e.g., specifying crafting/cooking/recipes or gift tastes for new items). It currently supports creating big craftables, boots, crafting recipes, crops, fences, forge recipes, fruit trees, furniture, hats, machine recipes, melee weapons, objects, gift tastes, pants, shirts, shop entries, tailoring recipes, and texture overrides.
Farm Type Manager (FTM) Add farm-like spawning logic to any map. That includes spawning stumps, debris, forage, meteors, monsters, ores, etc.
Fashion Sense (FS) Allows for bigger accessories, hairstyles, hats, shirts, sleeves and pants, as well as animation support and more.
Mail Framework Mod (MFM) Add new mail with functionality like custom backgrounds, repeating mail, a wider variety of mail attachments, and support for multiple attachments. (Simple mail without the custom functionality can also be added via Content Patcher.)
Shop Tile Framework (STF) Add new shops or edit existing shop inventories with a wide variety of conditions.
TMXL Map Toolkit (TMXL) Add/edit in-game locations and maps. It includes a wide variety of specialized map functionality like crop layers, water color, tile actions, and Lua scripting.

See additional TMXL documentation.

Specialized frameworks

These have fewer than 100 content packs, but provide useful functionality for specific cases.

mod functionality
Content Patcher Animations (CP-A) Animate any texture loaded through Content Patcher, including for textures that can't normally be animated (e.g., item sprites).
Custom Companions (CC) Allows creating custom entities that can be spawned on maps or follow the player around. This includes animals in the world or wandering NPCs.
Custom Crafting Stations (CCS) Add customized crafting stations which opens menus with a limited selection of recipes, without those recipes cluttering up the vanilla crafting menus. The stations can be big craftables that are vanilla or added using Json Assets (JA). The stations can also be added via tiledata added to the map.
Custom Critters (CC) Add custom critters to the world, like butterflies and bees.
Custom Farm Loader (CFL) A simplified way of adding custom farms. Supports among other things spawning items/debris/resource clumps/beach drops and setting fishing rules within your farms context.
Custom Obelisks (CO) Add custom obelisks that let you teleport from the farm to any location, as well as totems.
Custom Ore Nodes (CON) Add rock/mineral types you can break to get items, either custom or from the base game.
Custom Resource Clumps (CRC) Add new types of boulder-sized resource clumps you can break to get items, either custom or from the base game.
Custom Winter Star Gifts (CWSG) Change the gifts people give at the Winter Star festival via a set of many add and replace instructions.
Expanded Storage (ES) Adds custom storages (chests, cabinets, etc.) that support capacity at vanilla levels and beyond.
Quest Framework (QF) Add modders the ability to create custom quests, define custom quest types and handle quests on the back-end.
Train Station (TS) Make new locations accessible through the railroad train station, so you don't need to patch paths/warps into existing maps.
Unlockable Areas (UA) Makes map overlays purchaseable through a interactable shop.

See also

  • Modding:Index for different ways to create mods, and more detailed documentation.