From f6b1c45d4efc91d1f2b0d2ef043230bab94a882f Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Sat, 4 Jan 2025 23:16:56 +0000 Subject: [PATCH] Update readme Add changelog for rolling releases (on main) --- CHANGELOG.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 43 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..f4707615 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,41 @@ +# Release Notes 2024-12-30 + +- **New Features** + - Introduced menu sound effects for enhanced user experience (the default is off). + - Added N64 ROM autoload functionality, allowing users to set a specific ROM to load automatically. + - Added menu boot hotkey (hold `start` to return to menu when autoload is enabled). + - Added context menu and settings management options GUI for managing various settings in `config.ini`. + - Added functionality for editing the real-time clock (RTC) within the RTC menu view. + - Improved flashcart info view for showing supported flashcart features and version. + - Enhanced UI components with new drawing functions and improved organization. + - Added emulator support for `SMS`, `GG`, and `CHF` ROMs. + - Enhanced joypad input handling for menu actions, improving responsiveness. + - Optimized boxart image loading from filesystem. + - Improved various text to make the functionality more clear. + +- **Bug Fixes** + - Improved error handling in multiple areas, particularly in save loading and ROM management. + - Enhanced memory management to prevent potential leaks during error conditions. + - Fixed text flickering in certain circumstances. + +- **Documentation** + - Updated README and various documentation files to reflect new features and usage instructions. + - Added detailed setup instructions for SD cards and menu customization. + - Enhanced clarity in documentation for RTC settings and menu customization. + - Improved organization and clarity of SD card setup instructions for various flashcarts. + +- **Refactor** + - Standardized naming conventions across UI components for better organization. + - Restructured sound management and input handling for improved responsiveness. + - Streamlined the loading state management for ROMs and disks within the menu system. + - Improved clarity and usability of the developer guide and other documentation files. + +### Current known Issues +* The RTC UI requires improvement (awaiting UI developer). +* BETA_SETTING: PAL60 when using HDMI mods has regressed (awaiting libdragon fix). +* ALPHA_FEATURE: ED64 X Series detection does not occur properly (however this is not a problem as not tag released asset). +* ALPHA_FEATURE: ED64 V Series only supports loading ROMs (however this is not a problem as not tag released asset). +* Menu sound FX may not work properly when a 64 Disk Drive is also attached (work around: turn sound FX off). + +### Breaking changes +* Disk drive expansion ROMs are now loaded with `Z|L` instead of `R` to align with ROM info context menu (and future functionality). diff --git a/README.md b/README.md index b095550d..c0a581f5 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ An open source menu for N64 flashcarts. * Music playback (MP3). * Menu sound effects. * N64 ROM autoload. +* ROM information descriptions. +* ROM history and favorites. ## Documentation