Assets of other users: All of the assets in this Mail Framework Mod file are either the author’s or free-to-use modder’s resources.
Upload authorization: Under no circumstances may you upload this material to other websites.
Permission to modify: You may alter my files and provide bug patches or enhancements as long as you acknowledge me as the original inventor.
Permission to convert: Under no circumstances are you permitted to convert this Mail Framework Mod file for use in other games.
Permission to utilize an asset: You may use the materials in this Mail Framework Mod file without asking permission as long as you credit me.
Asset use authorization in purchased mods/files: This file’s assets may not be used in any modifications or files that are sold for money on Steam Workshop or other platforms.
Permission to utilize assets in mods/files that earn donation points: If your modifications use my materials, you may earn Donation Points for them.
Notes from the Author This framework may be used in your modifications.
File credits This Mail Framework Mod was inspired by the implementation of mail delivery done by Platonymous on his “The Harp of Yoba Redux” mod
CHANGELOGS
Version 1.15.0
New API Interface for SMAPI mods.
API method to load content pack folder from inside your SMAPI mod.
API method to load a letter.
API method to get a letter data.
API method to get the mail data string of a letter.
Fix mailbox not working properly when an error happened when closing the letter.
Better log on those errors.
Version 1.14.0
More changes for compatibility with SMAPI 4
New attribute in the letter class to set the ITranslationHelper.
Content pack don’t need to change anything, but this change should avoid some rare i18n issues.
Mods that use MFM through code can update their implementation.
Version 1.13.0
Make the mod compatible with SMAPI 4.
New property for Deepest mine level.
New property for current money.
New property for total money earned.
New console command to force mailbox to update to help modders debug.
Letter collection menu now show custom close button too.
Version 1.12.2
Make the mod compatible with 1.5.5, without forcing SMAPI to convert it.
Should fix some problems with attachment not working on Unix OS.
New property for House Upgrade Level.
Version 1.12.1
Fixed error when Expanded Preconditions Utility was not loaded.
Version 1.12.0
New properties to support the use of Expanded Preconditions
New property to make it possible to add text besides the letter id to the player’s MailReceived list.
Version 1.11.0
Support to DGA(Dynamic Game Assets) as attachments.
Version 1.10.2
Fix to cooking recipes names in English showing as null, when added by Json Assets.
Version 1.10.1
Fix to Auto Open letters with no text breaking the mod when there is i18n files.
Fix to letter from content pack not loading after one collection condition warning.
Adds new collection requirement type for crafting recipes.
Version 1.10.0
All vanilla tools are now supported.
Support to vanilla Slingshots as weapons. If you use the index or the name of an slingshot it will be properly created as such.
New “Auto Open” property, for when you want to use MFM conditions to save a letter id as read without writing an actual letter.
Version 1.9.2
Optimization for assets loading from content packs.
Fix to callback of letters not being called if a menu was opened to add an item to the inventory.
Version 1.9.1
Fix a bug where MFM letter would not be opened and removed from the box for the current day if you were holding an object when clicking the mailbox.
Mail Framework Mod Version 1.9.0
New property for letter created with SMAPI to add items dynamically to the letter.
New method to remove letters from the mailbox.
Mail Framework Mod Version 1.8.1
Fix to avoid conflict mails in local coop.
Fix to rare situations the mod would stop work if a letter menu was not properly closed by the game.
Mail Framework Mod Version 1.8.0
Support for Furniture, Weapons and Boots as attachments.
New property to set the upgrade level of attached tools.
Mail Framework Mod Version 1.7.0
Support for Rings as attachments.
New conditions for recipes.
New property for background customization with content packs.
Support to Close Button customization with content pack and code.
Mail Framework Mod Version 1.6.0
Support to i18n in content packs.
New conditions properties for buildings in the farm.
New conditions properties for mail received. (this is used for quest flags)
New conditions properties for events.
New conditions list for collections menu items.
New conditions list for game stats.
New property for friendship status for the conditions list for NPC friendship.
New random functionality for when Group Ids collide.
Mail Framework Mod Version 1.5.1
Fix to letters with no group ids being grouped together.
Mail Framework Mod Version 1.5.0
Letter will now be shown in the collection menu if an Title is defined. Custom textures and color will also show in the collection menu.
Letter now can have a group id. Letter with the same group id are never delivered in the same day.
New condition for content packs: “RandomChance”.
BigObject is now called BigCraftable, like in the game code.
Fix of typos in the template.
Mail Framework Mod Version 1.4.1
Adds support to Stardew Valley 1.4.0
Adds Title property for Letters to be shown in the collection menu. Not fully implemented yet, but modders can start to set it.
Mail Framework Mod Version 1.4.0
Adds an content pack support for modders to add custom letters, with configurations to all features this framework provides, and with mostly common used delivery conditions.
Fix controllers not working to get attached items.
Fix to properly show attachments if the mail has more than one item attached.
Fix to not let the letter close if your inventory is full and a menu is opened to manage it.
Fix to not adding an stack of items to the mail even when configured to.
Adds support to SMAPI 3
DESCRIPTIONS
Simplify mail delivery to the player by providing them more choice over when and what they receive. Giving additional possibilities not achievable by just modifying the data files, such as changing the text color and backdrop of the letter at will.
Compatibility Warning:
This mod is incompatible with FeTK and the Tool-Upgrade Delivery Service, both of which rely on it. They’ve been broken and unsupported for over a year, and even a simple letter won’t function with it. (Letters from the Adventure Guild) As a result, you need uninstall both before installation, or your custom mails will not function correctly. Fortunately, Mail Services Mod, an alternative to Tool-Upgrade Delivery Services, performs the same thing and much more.
INSTALLATION
Install the latest version of SMAPI.
Unzip the MailFrameworkMod into /Stardew Valley/Mods.
