Modding:Content pack frameworks
Revision as of 02:35, 16 January 2022 by Violetlizabet (talk | contribs)
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.
Active frameworks
Core frameworks
These are the most popular frameworks (with at least 100 released content packs each) used to create a wide variety of mods.
| 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. |
| 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. |
| Producer Framework Mod (PFM) | Add/change the inputs/outputs/behaviour of any machine in the game. That includes vanilla machines (e.g., casks), machines added by other mods, and adding machine logic to any big craftable. |
Other frameworks
Many other frameworks provide specific functionality for content packs.
| mod | functionality |
|---|---|
| Alternative Textures (AT) | Enables texture variation for placeable objects, buildings and entities. This includes trees, animals, pets, farm buildings, plants, and more. |
| Content Patcher Animations (CPA, CP-A) | Animate any texture loaded through Content Patcher, including for textures that can't normally be animated (e.g., item sprites). |
| 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 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 Critters (CC) | Add custom critters to the world, like butterflies and bees. |
| Custom Furniture (CF) | Add new furniture items to the game. |
| Custom Music (CM) | Replace or add music tracks and sound effects. |
| 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. |
| 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. |
| Expanded Storage (ES) | Adds custom storages (chests, cabinets, etc.) that support capacity at vanilla levels and beyond. |
| Farm Type Manager (FTM) | Add farm-like spawning logic to any map in the game. 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. |
| Quest Framework (QF) | Add modders the ability to create custom quests, define custom quest types and handle quests on the back-end. |
| Mail Framework Mod (MFM) | Add new mail to the game 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. |
| Train Station (TS) | Make new locations accessible through the railroad train station, so you don't need to patch paths/warps into existing maps. |
| Custom Obelisks (CO) | Add custom obelisks that let you teleport from the farm to any location, as well as totems. |
| Custom Winter Star Gifts (CWSG) | Change the gifts people give at the Winter Star festival via a set of many add and replace instructions. |
See also
- Modding:Index for different ways to create mods, and more detailed documentation.