Release v1.5.1

Release Notes

For Players

New Features/Major Changes

1. Favorites Feature (by @ParadoxiKat):
   • You can now use Alt+1 through Alt+0 to access storable favorites slots.
   • Alt+- and Alt+= will cycle through stacks, adjusting the favorites slot numbers by 10 each. For example, switching to stack 2 changes Alt+1 through Alt+0 to refer to favorites 11-20.
   • Favorites are saved upon editing and are reloaded when the game restarts. Also, each of your farms have their own set of unique favorites.
   • To make starting new farms easier, you can save a set of default favorites with a hotkey (Alt+Backspace). Double-press to clear defaults. New farms will automatically load these default favorites.
   • To hear what's stored in a favorite slot, press Alt+number once. Press twice to move to the stored destination. If a slot is empty, select a destination with the ObjectTracker (using PageUp/PageDown keys), then press Alt+number twice to save. Pressing three times clears that slot.
   • Favorites System Enhanced with Coordinate Saving: Save and switch between raw coordinates and standard ObjectTracker destinations with a new toggle shortcut (default: Alt+`).
   • Favorites Stack Reset on Warp: For a smoother transition during gameplay, we've implemented a reset of favorite stacks to the first stack upon warping, enhancing the overall user experience.
2. Chat and Notification messages reading
   • We can now use LeftAlt + Num keys (1-9) to speak the last 9 chat messages
   • Similarly, RightAlt + Num keys (1-9) or LeftAlt + LeftShift + Num keys (1-9) speak the last 9 notification messages
3. The mod's Screen Reader module is now replaced by CrossSpeak, a C# library for accessing the active screen reader in windows, mac and linux.

UI Enhancements

• Character Design Controls Visibility:
  • These controls are now visible by default.
  • A toggle key remains available for hiding them.
  • New configuration entry to set default visibility on startup.

Now Tracked

• Gates and pressure pads in volcano dungeon levels are now tracked.
• Similarly, minecarts, coal bags and dirt patches in mine shafts are also tracked. There is a new config (ReadHoedDirtInMineShafts) that toggles speaking hoed dirt (soil) in mineshafts which is disabled by default.
• Items inside of a machine (like casks, crystalarium) are now also read.

Bug Fixes

• Resolved Game Freezes: Fixed an issue where loading IsEvent as null from JSON caused game freezes typically after saving user tiles via the new menu (shift + enter).
• Corrected Case Sensitivity in tiles.json: Addressed a minor but important case sensitivity issue in tiles.json, changing "BlackSmith" to "Blacksmith". This enables the entry to be loaded to provide important destinations for the Blacksmith.
• Fixed a bug in tile viewer that speaks the location of the unreachable tiles incorrectly.

Localization Fixes

• English Plurals:
  • Added 'quartz', 'starfish' and 'hops' to irregular plurals.
  • Included 'bottles of wine', 'globs of slime', 'pieces of meat' in modified irregulars.
  • Added boysenberries and coral to irregulars

For Mod Translators

New Translations

In en.ftl

• tile-mine_shaft-coal_bag
• tile-mine_shaft-dirt
• tile-mine_shaft-duggy_hole
• tile-volcano_dungeon-pressure_pad
• tile-volcano_dungeon-gate

For Developers

Technical Updates

• As stated above, the mod now uses CrossSpeak library for accessing the screen readers.
• JSON Handling:
  • Migrated from System.Text.Json to Newtonsoft.Json (Json.NET) for more streamlined and standardized JSON processing.

Bug Fixes and Contributions

• Mono.Cecil Conflicts:
  • Fixed conflicts with Mono.Cecil, thanks to contributions from @paxcoder.