Skip to content

Latest commit

 

History

History
353 lines (246 loc) · 12.1 KB

CHANGELOG.md

File metadata and controls

353 lines (246 loc) · 12.1 KB

Changelog

0.18.1

Released November 14th, 2022.

General

  • Changed how icons are displayed in Local Notices when there are more than three notice icons on a given day.

Fixes

  • Add error handling if an error occurs in a page's activation or date changed event handler.
  • Rewrite the logic of the Local Notices page to hopefully fix issues some users are seeing that causes the Almanac to break.

Mod Compatibility

  • Added support for the Spenny mod.

0.18.0

Released November 4th, 2022.

General

  • When hovering over a day on the crops calendar, if there are more than five crops to display in the tool-tip, display two columns.

Fixes

  • Better handling for invalid dates when displaying things on calendars.
  • Do not display anniversaries for NPCs with whom a player is divorced.
  • Improve seed handling for random number generation to hopefully fix issues with some information in the Almanac appearing offset by a number of days.

Mod Compatibility

  • Added support for the Stardew Aquarium mod to the fishing page.
  • Switch to using new API endpoints when querying Json Assets and More Giant Crops for giant crop information.
  • Added support for the as of yet unreleased Giant Crop Tweaks mod.

0.17.0

Released May 10th, 2022.

General

  • Added an option to limit the displayed future forecast for luck and/or weather to a certain number of days.

Fixes

  • Pre-warm RNG for weather and daily luck to generate better results.
  • Fix detection of fish available in the forest farm map.

Translation

  • Added Turkish and Thai translations! Thank you!

Maintenance

  • Update to the new content APIs made available in SMAPI 3.14+
  • Update code to use file-scoped namespaces and nullable references.
  • Update color parsing code to be more efficient and support all named CSS4 colors.
  • Internal changes to better support the eventual migration to 1.6.

API / Content Packs

  • Added mouse cursors, standard scroll elements, and standard tool-tips to themes.
  • Added API endpoints for accessing weather data.
  • Added better handling for Local Notices via content packs, including support for Game State Query and token strings.
  • Added support for custom Fortune events via content packs, using the same format as Local Notices.

0.16.0

Released March 24th, 2022.

General

  • Replace the Almanac cover design with one based on certain elements of the community center bundle UI.
  • Added an option to filter the Planting Dates page to only show crops that you have seeds for.
  • Improve scrolling behavior when page content changes. Notably the Planting Dates page will no longer scroll to the top when changing fertilizer or other flags.

Fixes

  • Fixed an issue with the fishing log not correctly showing fish that are catchable on the farm.
  • Fixed an issue with some crops displaying an incorrect growth time when fertilizer or other flags are enabled.
  • Reload the fishing page textures when the current theme changes or is otherwise reloaded.

Mod Compatibility

  • Add built-in support for Overgrown Flowery Interface.
  • Tweak the Vintage Interface themes.

Content Packs

  • Themes now have a PageOffsets object that allow them to change page textures for specific Almanac pages.
  • Now using the public version of ThemeManager for theme support, which has a few changes. Notably, theme assets now need to go into an assets/ sub-folder.

0.15.0

Released March 17th, 2022.

General

  • Added an option for configuring where the Open Almanac button appears in the inventory menu. It can still be disabled, but may need to be disabled again by users that had done so previously.
  • Added an option to display trains on the Local Notices page.
  • When cached data is invalidated, if the Almanac is open it will be refreshed immediately.
  • When Debug Mode is enabled, pressing F5 will refresh the Almanac from its data sources as though the update command was used.

Fixes

  • When invalidating Almanac data, invalidate notices.
  • When clicking a calendar date on the Local Notices page and that page is part of a multi-day event, scroll to the previous day with a log entry. This isn't perfect, but an improvement at least.

Mod Compatibility

  • Add built-in support for Vintage Interface 1.

Content Packs

  • Content Packs can now control crop, fish, and NPC visibility via Content Patcher. See the new and improved Author Guide for details.
  • Content Packs can now add Local Notices via Content Patcher. See the new and improved Author Guide for details.
  • Themes now have ScrollOffsetTop and ScrollOffsetBottom properties.

Maintenance

  • General code cleanup. Hopefully I didn't break anything.

0.14.0

Released March 15th, 2022.

Mod Compatibility

  • Added built-in support for Vintage Interface 2.

Translation

  • Improve Chinese translation coverage.

Content Packs

  • Added an al_theme command to list all themes, or change the current theme if called with an argument. al_theme reload will reload all themes, including the active theme. al_retheme can be used as a shortcut for that.
  • We now have support for themes. Themes replace the menu texture (currently only the entire texture, sorry) and also allow you to override certain colors used by Almanac, such as the text color and text shadow color. There is a theme template with all the "default" values, but also see the Vintage Interface 2 theme for an idea on how things work, especially with regards to a custom scrollbar for the standard page theme.

0.13.0

Released March 14th, 2022.

General

  • Added an option for displaying legendary fish on the fishing guide.
  • Added an option for displaying Traveling Merchant visits on the Local Notices page. Optionally, you can also display what stock the merchant is expected to be selling.
  • Add all the hard-coded fish from the base game to the fishing guide, such as those caught in the mines.

Fixes

  • Improve handling of malformed input data for fish and crops.
  • When using the Current Location filter and displaying trapped fish, check to see if we can actually catch those fish in a Crab Pot on the current map. Currently, we're not checking every single tile for salt-water status but hopefully the logic will be good enough. The ocean is pretty big, so we shouldn't need to check every tile, in theory?

0.12.1

Released March 12th, 2022.

General

  • The Current Location filter for fishing now says "Unfiltered" rather than "No" when inactive. This should make it more clear that it's not active.
  • Added a "Debug Mode" setting. Currently, this doesn't do a lot. The idea is that this will start showing more IDs and other internal information in the Almanac that would be useful for modders or translators working with it.

Fixes

  • Fish with multiple time ranges now show their time ranges correctly, rather than just repeating the first range.

Translation

  • Add a Chinese translation. Thank you, ninthalley!

0.12.0

Released March 12th, 2022.

General

  • Added a Fishing page! The fishing page lets you filter by several different categories, and shows you useful information about fish in the game. I tried to balance utility and cheatyness, but it still probably needs tweaks. If nothing else, I need to figure out how to handle locations that shouldn't be listed until you've visited them.
  • Almanac pages now have much nicer scrolling! You can scroll smoothly now, as well as by holding the middle mouse button. The scrollbar grows and shrinks depending on how much content there is. And when you click it, it grows a little too for visual feedback.
  • Now, when a crop can grow into a giant crop, you can mouse over the words giant crop to view an image of it.

Fixes

  • Fixed an issue with crop data failing to load if a single crop has corrupt data. Now, the bad crop will be logged and processing will continue.
  • Fixed an incorrect duration calculation being performed for some custom crops, specifically when fertilizer was being used.
  • Fixed an exception when joining a split-screen game where Almanac tried opening its menu while the game was still loading.

Mod Compatibility

  • Added support for the Luck Skill mod. Calculations are performed based on the assumption that all farmers will be online and on the same team.
  • Fixed DynamicGameAssets crops failing to load at all when encountering a problem with a single crop. Now, an error is logged for every bad crop but the process continues.
  • DynamicGameAssets crops will now display when out of season, as long as their dynamic fields are sufficiently simple to parse manually.
  • DynamicGameAssets crops will now show their regrow times more correctly, though still likely a bit wrong due to how they handle phases.
  • Add support for More Giant Crops and JsonAssets giant crop sprites.
  • Add Stardew Aquarium and Stardew Valley Expanded location names to the default languages for display in Almanac menus that use locations.

(Internal) C# API Changes

  • AlmanacMenu now has support for a "Seasonal" page type, which displays the season picker but does not display the calendar.
  • AlmanacMenu now has support for separate left and right Flow scrolls.
  • There is a new management class for a scrollable Flow that manages events and components. Makes it much easier to integrate.
  • Made a bunch of tweaks and improvements to Flow so that we can have nice, smooth scrolling.

0.11.0

Released March 3rd, 2022.

General

  • Added settings to hide different sets of notices in the Local Notices page. So far, you can show or hide: Anniversaries, Gathering, and Festivals separately.
  • Added festivals and anniversaries to the Local Notices page.
  • Added support for scrolling the Almanac's tabs when there are more than nine tabs to display. This currently isn't important, but it will be in the future as other mods add their own content to Almanac (with any luck).
  • Try to snap the cursor better when scrolling with a gamepad.
  • Only display birthdays for NPCs we can socialize with on the Local Notices' tab, for now. There might be a better way to handle this in the future, but this seems to prevent spoilers from happening?
  • When there are multiple notices on a day, and there is no NPC with a birthday on that day, display up to three separate notice icons before giving up and displaying a rotating icon.

Bug Fixes

  • Fixed an issue with the game menu overlay spamming errors when the menu does not have a components list.
  • Fixed the Crop Previews setting not working to disable that feature.

0.10.1

Released March 3rd, 2022.

General

  • Make the PageUp, PageDown, Home, and End keys more useful when viewing long text on Almanac pages.

  • Fix vertical centering of calendar labels.

  • Fix a bug with the wrong cutscene flag being checked, resulting in being unable to open the Almanac after saving and loading.

Translation

  • Add initial Portuguese translation, thanks for Pedrowser on NexusMods!
  • Add initial Russian translation, thanks to AveAcVale on GitHub!

C# API Changes

  • Nothing yet, but work is underway on an API for adding custom pages. I might end up waiting for SMAPI 3.14 for support for generics in API interfaces.

0.10.0

Released March 2nd, 2022.

General

  • Make the Almanac remember its previous state when you close and re-open it.
  • Remember the scroll position when changing pages in the Almanac.
  • Add hazelnut season to the Local Notices page.
  • Stop recalculating page contents if the date changes but the season has not.
  • Add more keyboard bindings for the Almanac menu.

Translation

  • Add support for translating events, both with normal translation keys and by supporting entirely different event.json files when more significant changes are required.

C# API Changes

  • Add methods for adding entries to the Fortune and Local Notices page.

0.9.0

Released March 1st, 2022.

  • Initial release.