mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-01-23 07:11:14 +01:00
9113d1c949
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> This PR merges `develop` and `main` for a tagged release so it can be used by most users (utilising debug flags where required). ## Release Notes - **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). ## 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 --> Merge the changes: #110 #106 #101 #89 #74 and other improvements. ## 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. --> Locally on an SC64. ## Screenshots <!-- (if appropriate): --> ![image](https://github.com/user-attachments/assets/799fc21c-8743-4c21-8449-b4f531d5c62c) ## 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 - [ ] 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** - Enhanced documentation for N64 Flashcart Menu, including new emulator support and features like menu sound effects and N64 ROM autoload. - Added support for additional flashcart features and firmware version retrieval in the flashcart subsystem. - Introduced new settings for sound effects and ROM autoloading in the menu system. - **Bug Fixes** - Improved error handling in various menu functions to prevent memory leaks and ensure proper resource management. - **Refactor** - Updated naming conventions for UI component functions to improve clarity and organization. - Restructured the sound management functionality to enhance user interaction feedback. - **Documentation** - Expanded sections in README and other documentation files for clarity on emulator support and usage instructions. - **Chores** - Updated dependencies and version references in Dockerfile and other configuration files. <!-- 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>
127 lines
3.4 KiB
YAML
127 lines
3.4 KiB
YAML
name: Build
|
|
|
|
on:
|
|
push:
|
|
pull_request:
|
|
release:
|
|
types:
|
|
- created
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
build-menu:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: write
|
|
packages: write
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
submodules: recursive
|
|
|
|
- name: Login to GitHub Container Registry
|
|
uses: docker/login-action@v3
|
|
with:
|
|
registry: ghcr.io
|
|
username: ${{ github.repository_owner }}
|
|
password: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Build N64FlashcartMenu ROM
|
|
uses: devcontainers/ci@v0.3
|
|
with:
|
|
imageName: ghcr.io/polprzewodnikowy/n64flashcartmenu-devcontainer
|
|
cacheFrom: ghcr.io/polprzewodnikowy/n64flashcartmenu-devcontainer
|
|
push: ${{ github.repository_owner == 'Polprzewodnikowy' && 'filter' || 'never' }}
|
|
refFilterForPush: refs/heads/main
|
|
runCmd: |
|
|
make all -j
|
|
env:
|
|
FLAGS: -DNDEBUG
|
|
|
|
- name: Upload artifact (Standard ROM)
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: N64FlashcartMenu
|
|
path: |
|
|
./output/N64FlashcartMenu.n64
|
|
./build/N64FlashcartMenu.elf
|
|
|
|
- name: Upload artifact (64drive version)
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: 64drive
|
|
path: ./output/menu.bin
|
|
|
|
- name: Upload artifact (ED64 version)
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: ED64
|
|
path: ./output/OS64.v64
|
|
|
|
- name: Upload artifact (ED64P version)
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: ED64P
|
|
path: ./output/OS64P.v64
|
|
|
|
- name: Upload artifact (SC64 version)
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: SC64
|
|
path: ./output/sc64menu.n64
|
|
|
|
- name: Upload rolling release
|
|
uses: softprops/action-gh-release@v2
|
|
if: github.ref == 'refs/heads/main'
|
|
with:
|
|
name: Rolling release
|
|
body: Rolling release built from latest commit on `main` branch.
|
|
tag_name: 'rolling_release'
|
|
make_latest: true
|
|
files: |
|
|
./output/N64FlashcartMenu.n64
|
|
./output/menu.bin
|
|
# ./output/OS64.v64
|
|
# ./output/OS64P.v64
|
|
./output/sc64menu.n64
|
|
continue-on-error: true
|
|
|
|
- name: Upload dev rolling release
|
|
uses: softprops/action-gh-release@v2
|
|
if: github.ref == 'refs/heads/develop'
|
|
with:
|
|
name: 'Rolling pre-release'
|
|
body: Experimental pre-release built from latest commit on `develop` branch.
|
|
target_commitish: develop
|
|
tag_name: 'rolling_pre-release'
|
|
prerelease: true
|
|
files: |
|
|
./output/N64FlashcartMenu.n64
|
|
./output/menu.bin
|
|
./output/OS64.v64
|
|
./output/OS64P.v64
|
|
./output/sc64menu.n64
|
|
continue-on-error: true
|
|
|
|
generate-docs:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: write
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Run Doxygen
|
|
uses: mattnotmitt/doxygen-action@v1
|
|
with:
|
|
doxyfile-path: './Doxyfile'
|
|
|
|
- name: Deploy to GitHub Pages
|
|
uses: peaceiris/actions-gh-pages@v4
|
|
if: github.ref == 'refs/heads/main'
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: ./output/docs
|
|
cname: menu.summercart64.dev
|