Skip to content

Commit

Permalink
[main] Add changelog (#188)
Browse files Browse the repository at this point in the history
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
Add changelog so that rolling release description does not need to be
updated manually.

## 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 -->
Hard to maintain.

## 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)
- [ ] 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! -->
- [ ] 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

## Release Notes

- **New Features**
	- Added menu sound effects (default off)
	- Introduced N64 ROM autoload functionality
	- Implemented a menu boot hotkey
	- Added a context menu for settings management
	- Enhanced real-time clock (RTC) editing capabilities
	- Improved flashcart information display
	- Optimized joypad input handling for responsiveness
	- Added support for additional ROM types (`SMS`, `GG`, and `CHF`)

- **Improvements**
	- Enhanced UI layout with new drawing functions and better organization
	- Optimized boxart image loading
	- Improved memory management to prevent leaks

- **Bug Fixes**
	- Enhanced error handling in save loading and ROM management
	- Fixed text flickering issues

- **Documentation**
	- Updated CHANGELOG with latest release notes
	- Revised README for new features and setup instructions
	- Improved clarity regarding RTC settings and menu customization

- **Breaking Changes**
- Loading of disk drive expansion ROMs now requires a different key
combination
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
networkfusion authored Jan 10, 2025
1 parent d18b669 commit 52599e9
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:
if: github.ref == 'refs/heads/main'
with:
name: Rolling release
body: Rolling release built from latest commit on `main` branch.
body_path: ${{ github.workspace }}/CHANGELOG.md
tag_name: 'rolling_release'
make_latest: true
files: |
Expand All @@ -92,7 +92,7 @@ jobs:
if: github.ref == 'refs/heads/develop'
with:
name: 'Rolling pre-release'
body: Experimental pre-release built from latest commit on `develop` branch.
body: Experimental pre-release built from latest commit on `develop` branch. Check the commit history for more details.
target_commitish: develop
tag_name: 'rolling_pre-release'
prerelease: true
Expand Down
48 changes: 48 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
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 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).

0 comments on commit 52599e9

Please sign in to comment.