The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2025-02-21 12:17:15 +01:00
Code Issues Packages Projects Releases Wiki Activity
N64FlashcartMenu/CHANGELOG.md
Robin Jones 1a9e292598 [develop] Documentation manual (#198) 
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
Reworks and splits the documentation.

## 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 -->
Improves documentation to be more readable.

## How Has This Been Tested?
<!-- (if applicable) -->
<!--- Please describe in detail how you tested your sample/changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots
<!-- (if appropriate): -->

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Improvement (non-breaking change that adds a new feature)
- [ ] Bug fix (fixes an issue)
- [ ] Breaking change (breaking change)
- [x] Documentation Improvement
- [ ] 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! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] 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

Based on the comprehensive summary, here are the release notes:

- **New Features**
  - Added ROM history and favorites functionality
  - Introduced tabbed interface for file browsing
  - Implemented ROM information descriptions
  - Added support for ROM configuration overrides
  - Enhanced menu settings management

- **Documentation**
  - Expanded user guide and documentation
  - Added sections on ROM patches, controller PAKs, and emulator support
  - Improved flashcart and menu customization instructions

- **Chores**
  - Updated documentation structure
  - Refined code organization and naming conventions
  - Updated subproject references

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-01-12 23:41:32 +00:00

3.5 KiB
Raw Blame History

Rolling release built from latest commit on main branch.
Note: the attached source code files may be out of date.

  • For the SummerCart64, use the sc64menu.n64 file in the root of your SD card.
  • For the 64Drive, use the menu.bin file in the root of your SD card.
  • For the ares emulator, use the N64FlashcartMenu.n64 file.

Release Notes 2025-01-10

  • Bug Fixes
    • Fixed menu display (PAL60) by reverted libdragon to a known working point and re-applying old hacks.

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). [Pre-release menu]:
  • 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).

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

  • BETA_SETTING: PAL60 when using HDMI mods has regressed (awaiting libdragon fix).
  • 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).
  • 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).

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).