22515a6fdf
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> ### Release Notes 2025-03-31 - **New Features** - Introduced tabs in main menu for ROM favorites and recently played ROM history. - Introduced first run check to ensure users are aware of latest changes. - Introduced ability to turn off GUI loading bar. - BETA_FEATURE: Introduces ROM descriptions from files. - BETA_FEATURE: Enabled setting for fast ROM reboots on the SC64. - Add macOS metadata to hidden files. - Added settings schema version for future change versioning. - Added setting for PAL60 compatibility mode (see breaking changes). - BETA_FEATURE: Added setting for line doublers that need progressive output, enable using "force_progressive_scan" setting in `config.ini`. - **Bug Fixes** - Menu sound FX issues (hissing, popping and white noise). - RTC not showing or setting correct date parameters in certain circumstances. - GB / GBC emulator not saving in certain circumstances. - **Documentation** - Re-orginised and improved user documentation. - Added a lot of doxygen compatible code comments. - Added project license. - **Refactor** - RTC subsystem (align with libDragon improvements). - Boxart images (Deprecates old boxart image folder layout). - Settings (PAL60 compatibility, schema version, fast reboot, first run, progress bar). - **Other** - Updated libDragon SDK. - Updated miniz library. ### Breaking changes * GB /GBC emulator changed save type to SRAM (from FRAM) to improve compatibility with Summercart64 (which only uses H/W compatible FRAM), this may break your ability to load existing saves. * For similar PAL60 functionality, you may need to also enable the new "pal60_compatibility_mode" setting in `config.ini`. ### Current known Issues * The RTC UI requires improvement (awaiting UI developer). * Menu sound FX may not work properly when a 64 Disk Drive is also attached (work around: turn sound FX off). * Fast Rebooting a 64DD disk once will result in a blank screen. Twice will return to menu. This is expected until disk swapping is implemented. * MP3 Player crashes menu if the MP3 file's sample rate is less than 44100 hz. ### Deprecation notices * Autoload ROM's will be deprecated in favor of Fast Reboot in a future menu version. * Old boxart images using filenames for game ID is deprecated and the compatibility mode will be removed in a future release. ## Motivation and Context <!--- What does this sample do? What problem does it solve? --> <!--- If it fixes/closes/resolves an open issue, please link to the issue here --> Works towards next release to main. ## How Has This Been Tested? On a SummerCart64 ## Screenshots <!-- (if appropriate): --> ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [x] Improvement (non-breaking change that adds a new feature) - [x] Bug fix (fixes an issue) - [x] Breaking change (breaking change) - [x] Documentation Improvement - [x] Config and build (change in the configuration and build system, has no impact on code or features) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] My code follows the code style of this project. - [x] My change requires a change to the documentation. - [x] I have updated the documentation accordingly. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. <!--- It would be nice if you could sign off your contribution by replacing the name with your GitHub user name and GitHub email contact. --> Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **New Features & Enhancements** - Introduced dynamic history and favorites management for ROM and disk selections with a new tabbed interface. - Added support for autoloading ROMs, 64DD disk emulation, emulator integration, MP3 playback, and custom background images. - Expanded settings options—including PAL60 compatibility and fast ROM reboots—and improved startup behavior with an introductory credits display. - Added a feature to toggle the loading progress bar and enhanced the display of ROM information. - Implemented a bookkeeping system for managing history and favorites, along with new context menu entries for toggling settings. - Added a new user guide for N64FlashcartMenu and introduced a FAQ section addressing common issues. - Enhanced the user interface with new tabs for managing ROM favorites and recently played ROMs. - Introduced first run checks for user awareness of changes. - **Bug Fixes** - Resolved issues related to menu sound effects, RTC date parameters, and saving functionality in the GB/GBC emulator. - **Documentation** - Overhauled and expanded user guides, FAQs, and README materials to provide clearer instructions on ROM configuration, cheats, flashcart support, and new features. - Added detailed documentation comments throughout the codebase to improve clarity and maintainability, including updates to the pull request template and license information. - Included a new section in the CHANGELOG detailing various updates and breaking changes. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL> Co-authored-by: Suprapote <111246491+Suprapote@users.noreply.github.com> Co-authored-by: Christopher Bonhage <me@christopherbonhage.com> Co-authored-by: Mateusz Faderewski <sc@mateuszfaderewski.pl> Co-authored-by: Fazana <52551480+FazanaJ@users.noreply.github.com> Co-authored-by: Guillermo Horacio Romero Villa <65469983+E1ite007@users.noreply.github.com> Co-authored-by: Ross Gouldthorpe <github@thegouldfish.co.uk> Co-authored-by: Víctor "IlDucci <IlDucci@users.noreply.github.com> Co-authored-by: XLuma <39510265+XLuma@users.noreply.github.com> Co-authored-by: thekovic <72971433+thekovic@users.noreply.github.com>
2.7 KiB
ROM Configuration
The N64FlashcartMenu allows overriding the ROM's default configuration that is provided from the internal database.
The internal database is contained within rom_info.c.
The N64FlashcartMenu expects that you are using a flashcart that has an UltraCIC available.
NOTE: Some old ROM hacks may have adjusted the ROM code to manipulate the expected CIC and save type in order to allow compatibility with more available chips (usually 6102) as was used on flashcarts prior to 2018. If it does, you may need to override the internal database using the override settings.
If you override the defaults and want to go back to the default ones, delete the <rom name>.ini file.
Homebrew Header
The N64FlashcartMenu fully supports the homebrew header
Available Overrides
CIC type
The Checking Integrated Circuit CIC was a physical security chip used by retail Nintendo 64 game cartridges that prevented unlicensed and pirated game cartridges from running and used in conjunction with the PIF.
WARNING: Changing the CIC type to an unsupported one may result in a blank screen for that particular ROM until you manually delete the override file!
For more detailed information regarding the various CIC chips, please visit micro-64.com's game CIC database.
Save type
Games that have been programmed to include an internal save system might use various types of chips, methods and sizes.
WARNING: Using the wrong save type can cause unwanted behaviors on games and/or corrupt existing ones!
For more detailed information regarding the various saving methods, please visit micro-64.com's game save database
TV Region type
All ROMs are generally programmed to work with a single type of television output setting, whether it's NTSC, PAL or MPAL or their multiple variants. Forcing the region will generally make the ROM work on your display, however:
- Be aware that not every CRT from the 1990s and 2000s is compatible with both NTSC and PAL standards.
- Be aware that flat TVs from late 2010s-2020s might have other issues, such as when a game changes its internal resolution during gameplay (i.e. Resident Evil 2 with Expansion Pak).
- Expect potential side effects:
- Speed issues
- Audio/visual desynchronization
- Other unexpected/unwanted behaviors
Autoload
See the Autoload N64 ROMs page.