which-framework-to-use.md

Below is a list of frameworks commonly used by contentsmiths. If you have any questions about which one to use, feel free to come ask in #making-mods. The most common abbreviation for framework names have been added to ones that are commonly abbreviated. Original list compiled by Jonqora.

Content Patcher aka CP

• Edit or replace any game file in Content;
• Add new files (useful for making a new NPC);
• Edit images, data, or maps;

Content Patcher Animations aka CPA

• Used to animate images both vanilla and custom (either added through CP or JA);
• Requires Content Patcher

Custom Furniture aka CF

• Currently broken in 1.5
• Adds new items that behave like vanilla furniture - rotation, placeable on walls;
• If you don't need items to rotate or be placed on walls it is recommended to use JA with Bigger Craftables;
• Requires PyTK

Custom Music aka CM

• Replace or add new music tracks and sound effects;
• Requires PyTK

Custom Ore Nodes

• Makes new types of rocks you can break to get vanilla or custom items

Custom Resource Clumps

• Add new types of boulder-sized resource clumps you can break to get items, either custom or from the base game.

Custom TV

• Adds new stations via Content Patcher
• Requires PlatoTK and Content Patcher

Custom Walls and Floors aka CWF

• Adds new wallpaper and floors without replacing any of the vanilla ones;
• Is known to have issues in MP;

Expanded Storage

• Adds custom storages (chests, cabinets, etc.) that support capacity at vanilla levels and beyond.

Farm Type Manager aka FTM

• Spawn stumps, debris, forage, ores, meteors, etc.;
• Spawn monsters and create new monster types based on existing ones

Json Assets aka JA

• Adds new items: Objects, BigCraftables, Hats, Shirts, Pants, Shoes/Boots, Fences, Weapons, Crops, Fruit Trees, and recipes at the forge;
• Specify crafting/cooking/tailoring recipes;
• Specify gift tastes;
• New item data/images can be targeted with Content Patcher;
• Can use Bigger Craftables to make craftables larger than 16x32;
• Requires SpaceCore and Expanded Preconditions Utility

Mail Framework Mod aka MFM

• Allows you to send a variety of objects to the player including recipes;
• More in depth conditions than vanilla;
• Custom letter backgrounds without having to edit via CP

Producer Framework Mod aka PFM

• Successor to Custom Farming Redux;
• Change the input, output, and behavior of vanilla machines;
• New machines can be added with BigCraftables via JA;
• Animation support

Quest Framework aka QF

• Create new custom quests of different types

Shop Tile Framework aka STF

• Add or change what's for sale in vanilla shops;
• Create a new shop location with detailed conditions;
• Requires Expanded Preconditions Utility

TMXL Map Toolkit aka TMXL

• Necessary to add new locations;
• Lots of map features such as crop layers and water color;
• Requires PyTK

Train Station

• Make a new location accessible without patching vanilla maps