[main] Next release changes (#162)

## Description  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   Merge the changes: #110 #106 #101 #89 #74 and other improvements. ## How Has This Been Tested?     Locally on an SC64. ## Screenshots  ![image](https://github.com/user-attachments/assets/799fc21c-8743-4c21-8449-b4f531d5c62c) ## Types of changes  - [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:   - [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.  Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL>  ## 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.  --------- Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL> Co-authored-by: Suprapote <[email protected]> Co-authored-by: Christopher Bonhage <[email protected]> Co-authored-by: Mateusz Faderewski <[email protected]> Co-authored-by: Fazana <[email protected]> Co-authored-by: Guillermo Horacio Romero Villa <[email protected]>
Polprzewodnikowy · Dec 30, 2024 · 9113d1c · 9113d1c
1 parent 49ea127
commit 9113d1c
Show file tree

Hide file tree

Showing 69 changed files with 2,201 additions and 701 deletions.
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -1,6 +1,6 @@
 FROM debian:bookworm-slim
 
-ARG SC64_DEPLOYER_VERSION=v2.20.0
+ARG SC64_DEPLOYER_VERSION=v2.20.2
 RUN apt-get update && \
     apt-get upgrade -y && \
     apt-get install build-essential doxygen git python3 wget -y && \

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -77,7 +77,8 @@ jobs:
         with:
           name: Rolling release
           body: Rolling release built from latest commit on `main` branch.
-          tag_name: rolling-release
+          tag_name: 'rolling_release'
+          make_latest: true
           files: |
             ./output/N64FlashcartMenu.n64
             ./output/menu.bin
@@ -90,9 +91,10 @@ jobs:
         uses: softprops/action-gh-release@v2
         if: github.ref == 'refs/heads/develop'
         with:
-          name: 'Rolling dev release-V${{ github.run_id }}'
-          body: Rolling dev prerelease built from latest commit on `develop` branch.
-          tag_name: prerelease-dev
+          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
@@ -111,7 +113,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Run Doxygen
-        uses: mattnotmitt/doxygen-action@1.9.5
+        uses: mattnotmitt/doxygen-action@v1
         with:
           doxyfile-path: './Doxyfile'
 

diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@
 # Ignore generated files in the libdragon FS
 /filesystem/FiraMonoBold.font64
 /filesystem/*.wav64
+/filesystem/*.sprite
 
 # Ignore external development tools
 /tools/*

diff --git a/Makefile b/Makefile
@@ -29,6 +29,7 @@ SRCS = \
 	flashcart/64drive/64drive_ll.c \
 	flashcart/64drive/64drive.c \
 	flashcart/flashcart_utils.c \
+	flashcart/ed64/ed64_vseries.c \
 	flashcart/flashcart.c \
 	flashcart/sc64/sc64_ll.c \
 	flashcart/sc64/sc64.c \
@@ -40,11 +41,6 @@ SRCS = \
 	libs/miniz/miniz.c \
 	menu/actions.c \
 	menu/cart_load.c \
-	menu/components/background.c \
-	menu/components/boxart.c \
-	menu/components/common.c \
-	menu/components/context_menu.c \
-	menu/components/file_list.c \
 	menu/disk_info.c \
 	menu/fonts.c \
 	menu/hdmi.c \
@@ -55,6 +51,11 @@ SRCS = \
 	menu/rom_info.c \
 	menu/settings.c \
 	menu/sound.c \
+	menu/ui_components/background.c \
+	menu/ui_components/boxart.c \
+	menu/ui_components/common.c \
+	menu/ui_components/context_menu.c \
+	menu/ui_components/file_list.c \
 	menu/usb_comm.c \
 	menu/views/browser.c \
 	menu/views/credits.c \
@@ -77,24 +78,42 @@ SRCS = \
 FONTS = \
 	FiraMonoBold.ttf
 
+SOUNDS = \
+	cursorsound.wav \
+	back.wav \
+	enter.wav \
+	error.wav \
+	settings.wav
+
 OBJS = $(addprefix $(BUILD_DIR)/, $(addsuffix .o,$(basename $(SRCS))))
 MINIZ_OBJS = $(filter $(BUILD_DIR)/libs/miniz/%.o,$(OBJS))
 SPNG_OBJS = $(filter $(BUILD_DIR)/libs/libspng/%.o,$(OBJS))
 DEPS = $(OBJS:.o=.d)
 
 FILESYSTEM = \
-	$(addprefix $(FILESYSTEM_DIR)/, $(notdir $(FONTS:%.ttf=%.font64)))
+	$(addprefix $(FILESYSTEM_DIR)/, $(notdir $(FONTS:%.ttf=%.font64))) \
+	$(addprefix $(FILESYSTEM_DIR)/, $(notdir $(SOUNDS:%.wav=%.wav64))) \
+	$(addprefix $(FILESYSTEM_DIR)/, $(notdir $(IMAGES:%.png=%.sprite)))
 
 $(MINIZ_OBJS): N64_CFLAGS+=-DMINIZ_NO_TIME -fcompare-debug-second
 $(SPNG_OBJS): N64_CFLAGS+=-isystem $(SOURCE_DIR)/libs/miniz -DSPNG_USE_MINIZ -fcompare-debug-second
-$(FILESYSTEM_DIR)/FiraMonoBold.font64: MKFONT_FLAGS+=-c 1 --size 16 -r 20-1FF -r 2026-2026 --ellipsis 2026,1
+$(FILESYSTEM_DIR)/FiraMonoBold.font64: MKFONT_FLAGS+=--compress 1 --outline 1 --size 16 --range 20-7F --range 80-1FF --range 2026-2026 --ellipsis 2026,1
+$(FILESYSTEM_DIR)/%.wav64: AUDIOCONV_FLAGS=--wav-compress 1
 
 $(@info $(shell mkdir -p ./$(FILESYSTEM_DIR) &> /dev/null))
 
-$(FILESYSTEM_DIR)/%.font64: $(ASSETS_DIR)/%.ttf
+$(FILESYSTEM_DIR)/%.font64: $(ASSETS_DIR)/fonts/%.ttf
 	@echo "    [FONT] $@"
 	@$(N64_MKFONT) $(MKFONT_FLAGS) -o $(FILESYSTEM_DIR) "$<"
 
+$(FILESYSTEM_DIR)/%.wav64: $(ASSETS_DIR)/sounds/%.wav
+	@echo "    [AUDIO] $@"
+	@$(N64_AUDIOCONV) $(AUDIOCONV_FLAGS) -o $(FILESYSTEM_DIR) "$<"
+
+$(FILESYSTEM_DIR)/%.sprite: $(ASSETS_DIR)/images/%.png
+	@echo "    [SPRITE] $@"
+	@$(N64_MKSPRITE) $(MKSPRITE_FLAGS) -o $(dir $@) "$<"
+
 $(BUILD_DIR)/$(PROJECT_NAME).dfs: $(FILESYSTEM)
 
 $(BUILD_DIR)/menu/views/credits.o: .FORCE

diff --git a/README.md b/README.md
@@ -18,18 +18,21 @@ An open source menu for N64 flashcarts.
 * Fully Open Source.
 * Loads all known N64 games (including iQue and Aleck64 ROMs (even if they are byteswapped)).
 * Fully emulates the 64DD and loads 64DD disks (SummerCart64 only).
-* Emulator support (NES, SNES, GB, GBC) ROMs.
+* Emulator support (NES, SNES, GB, GBC, SMS, GG, CHF) ROMs.
 * N64 ROM box image support.
 * Background image (PNG) support.
 * Comprehensive ROM save database (including HomeBrew headers).
 * Comprehensive ROM information display.
 * Real Time Clock support.
 * Music playback (MP3).
+* Menu sound effects.
+* N64 ROM autoload.
 
 
 ## Documentation
 * [Getting started guide](./docs/00_getting_started_sd.md)
 * [Menu controls](./docs/01_menu_controls.md)
+* [Menu customization](./docs/07_menu_customization.md)
 * [Developer guide](./docs/99_developer_guide.md)
 
 ## Video showcase (as of Oct 12 2023)
@@ -48,12 +51,60 @@ An open source menu for N64 flashcarts.
 ## Experimental features
 These features are subject to change:
 
-### ROM Boxart
-To use boxart, you need to place png files of size 158x112 in the folder `/menu/boxart` on the SD card.
-Each file must be named according to the 2 letter ROM ID, or 3 letter ROM ID including media type.
-i.e. for GoldenEye 2 letters, this would be `GE.png`.
-i.e. for GoldenEye 3 letters, this would be `NGE.png`.
-A known set of PNG files using 2 letter ID's can be downloaded [here](https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w).
+### N64 ROM autoload
+To use the autoload function, while on the `N64 ROM information` display, press the `R` button on your joypad and select the `Set ROM to autoload` option. When you restart the console, it will now only load the selected ROM rather than the menu.
+The autoload setting is stored in `config.ini` and persists until changed. This feature may slightly increase boot time as the menu needs to check for the Start button state.
+NOTE: To return to the menu, hold the joypad `Start` button while powering on the console.
+
+### GamePak sprites
+To use N64 GamePak sprites, place PNG files within the `sd:/menu/boxart/` folder.
+
+#### Supported sprites
+These must be `PNG` files that use the following dimensions:
+* Standard N64 GamePak boxart sprites: 158x112
+* Japanese N64 GamePak boxart sprites: 112x158
+* 64DD boxart sprites: 129x112
+
+Supported PNG formats:
+* RGB/RGBA color formats
+* 8-bit color depth
+
+They will be loaded by directories using each character (case-sensitive) of the full 4 character Game Code (as identified in the menu ROM information).
+i.e. for GoldenEye NTSC USA (NGEE), this would be `sd:/menu/boxart/N/G/E/E/boxart_front.png`.
+i.e. for GoldenEye PAL (NGEP), this would be `sd:/menu/boxart/N/G/E/P/boxart_front.png`.
+
+To improve compatibility between regions (as a fallback), you may exclude the region ID (last matched directory) for GamePaks to match with 3 letter IDs instead:
+i.e. for GoldenEye, this would be `sd:/menu/boxart/N/G/E/boxart_front.png`.
+
+**Warning**: Excluding the region ID may show the wrong boxart.
+**Note**: For future support, boxart sprites should also include:
+* `boxart_back.png`
+* `boxart_top.png`
+* `boxart_bottom.png`
+* `boxart_left.png`
+* `boxart_right.png`
+
+As a starting point, here is a link to a boxart pack following the new structure, including `boxart_front.png` and failback images:
+* [Link](https://drive.google.com/file/d/1IpCmFqmGgGwKKmlRBxYObfFR9XywaC6n/view?usp=drive_link)
+
+
+#### Compatibilty mode
+If you cannot yet satisfy the correct boxart layout, The menu still has **deprecated** support for filenames containing the Game ID.
+
+**Note:** This will add a noticeable delay for displaying parts of the menu.
+
+Each file must be named according to the 2,3 or 4 letter GamePak ID (matched in this order).
+i.e.
+* for GoldenEye 4 letters, this would be `sd:/menu/boxart/NGEE.png` and/or `sd:/menu/boxart/NGEP.png`.
+* for GoldenEye 3 letters, this would be `sd:/menu/boxart/NGE.png`.
+* for GoldenEye 2 letters, this would be `sd:/menu/boxart/GE.png`.
+
+
+As a starting point, here are some links to boxart packs:
+* [Japan Boxart](https://mega.nz/file/KyJR0B6B#ERabLautAVPaqJTIdBSv4ghbudNhK7hnEr2ZS1Q6ub0)
+* [American Boxart](https://mega.nz/file/rugAFYSQ#JHfgCU2amzNVpC4S6enP3vg--wtAAwsziKa7cej6QCc)
+* [European Boxart](https://mega.nz/file/OmIV3aAK#kOWdutK1_41ffN64R6thbU7HEPR_M9qO0YM2mNG6RbQ)
+* [64DD Boxart](https://mega.nz/file/ay5wQIxJ#k3PF-VMLrZJxJTr-BOaOKa2TBIK7c2t4zwbdshsQl40)
 
 
 ### Menu Settings
@@ -73,15 +124,32 @@ If required, you can manually adjust the file on the SD card using your computer
 * Download the latest `menu.bin` file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
 
 
-### ED64 & ED64P
+### ED64 - WIP - UNTESTED AND UNSUPPORTED - USE AT OWN RISK
 Currently not supported, but work is in progress (See [PR's](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls)).
+**Warning**: The menu may be able to load ROMs but cannot guarantee save functionality. Existing saves may be corrupted.
 
-The aim is to replace [Altra64](https://github.com/networkfusion/altra64) and [ED64-UnofficialOS](https://github.com/n64-tools/ED64-UnofficialOS-binaries).
+#### ED64 (Vseries)
+The aim is to reach feature parity with [ED64-UnofficialOS](https://github.com/n64-tools/ED64-UnofficialOS-binaries) / [ED64-OfficialOS](https://krikzz.com/pub/support/everdrive-64/v2x-v3x/os-bin/).
+Download the `OS64.v64` ROM from the latest [action run - assets] and place it in the `/ED64` folder.
+
+#### ED64 (X series)
+X Series support is currently awaiting fixes. Please use the official [OS](https://krikzz.com/pub/support/everdrive-64/x-series/OS/) for now.
+
+#### ED64 (P clone)
+Download the `OS64P.v64` ROM from the latest [action run - assets] and place it in the `/ED64P` folder.
+The aim is to reach feature parity with [Altra64](https://github.com/networkfusion/altra64)
 
 
 # Open source software and licenses used
+
 * [libdragon](https://github.com/DragonMinded/libdragon) (UNLICENSE License)
 * [libspng](https://github.com/randy408/libspng) (BSD 2-Clause License)
 * [mini.c](https://github.com/univrsal/mini.c) (BSD 2-Clause License)
 * [minimp3](https://github.com/lieff/minimp3) (CC0 1.0 Universal)
 * [miniz](https://github.com/richgel999/miniz) (MIT License)
+
+## Sounds
+See [License](https://pixabay.com/en/service/license-summary/) for the following sounds:
+* [Cursor sound](https://pixabay.com/en/sound-effects/click-buttons-ui-menu-sounds-effects-button-7-203601/) by Skyscraper_seven (Free to use)
+* [Actions (Enter, back) sound](https://pixabay.com/en/sound-effects/menu-button-user-interface-pack-190041/) by Liecio (Free to use)
+* [Error sound](https://pixabay.com/en/sound-effects/error-call-to-attention-129258/) by Universfield (Free to use)
diff --git a/assets/FiraMonoBold.ttf → assets/fonts/FiraMonoBold.ttf b/assets/FiraMonoBold.ttf → assets/fonts/FiraMonoBold.ttf
diff --git a/assets/sounds/back.wav b/assets/sounds/back.wav
diff --git a/assets/sounds/cursorsound.wav b/assets/sounds/cursorsound.wav
diff --git a/assets/sounds/enter.wav b/assets/sounds/enter.wav
diff --git a/assets/sounds/error.wav b/assets/sounds/error.wav
diff --git a/assets/sounds/settings.wav b/assets/sounds/settings.wav
diff --git a/docs/00_getting_started_sd.md b/docs/00_getting_started_sd.md
@@ -1,11 +1,22 @@
 ## First time setup of SD card
 
-Using your PC, insert the SD card and ensure it is formatted for compatibility with your flashcart (*FAT32 and EXFAT are fully supported on the SC64*).
+### Flashcarts
+Using your PC, insert the SD card and ensure it is formatted for compatibility with your flashcart.
+**warning** Filenames are expected to be part of the ASCII character set. Unicode characters are not fully supported and may cause a crash screen.
+
+#### SC64
+- FAT32 and EXFAT are fully supported.
+- An SD formatted with 128 kiB cluster size is recommended.
 
 - Download the latest `sc64menu.n64` (assuming you are using an *sc64*) file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
 - Create a folder in the root of your SD card called `menu`.
 - Place your ROMs on the SD Card, in any folder (**except for `menu`**).
 
+#### Other supported flashcarts
+- FAT32 recommended.
+- An SD formatted with default cluster size is recommended.
+
+
 
 ### Emulator support
 Emulators should be added to the `/menu/emulators` directory on the SD card.
@@ -14,6 +25,8 @@ Menu currently supports the following emulators and associated ROM file names:
 - **NES**: [neon64v2](https://github.com/hcs64/neon64v2/releases) by *hcs64* - `neon64bu.rom`
 - **SNES**: [sodium64](https://github.com/Hydr8gon/sodium64/releases) by *Hydr8gon* - `sodium64.z64`
 - **Game Boy** / **GB Color**: [gb64](https://lambertjamesd.github.io/gb64/romwrapper/romwrapper.html) by *lambertjamesd* - `gb.v64` / `gbc.v64` ("Download Emulator" button)
+- **SMS** / **GG**: [smsPlus64](https://github.com/fhoedemakers/smsplus64/releases) by *fhoedmakers* - `smsPlus64.z64`
+- **Fairchild Channel F**: [Press-F-Ultra](https://github.com/celerizer/Press-F-Ultra/releases) by *celerizer* - `Press-F.z64`
 
 
 ### 64DD disk support
@@ -40,7 +53,9 @@ SD:\
 │        ├── neon64bu.rom
 │        ├── sodium64.z64
 │        ├── gb.v64
-│        └── gbc.v64
+│        ├── gbc.v64
+│        ├── smsPlus64.z64
+│        └── Press-F.z64
 │
 ├── (a rom).z64
 ├── (a rom).n64

diff --git a/docs/07_menu_customization.md b/docs/07_menu_customization.md
@@ -0,0 +1,5 @@
+# Menu customization
+
+## Using a custom font
+Add a `font64` file to the root directory called "custom.font64"
+This can be build using `libdragon` tools.
diff --git a/docs/99_developer_guide.md b/docs/99_developer_guide.md
@@ -45,10 +45,13 @@ For ease of development and debugging, the menu ROM can run in the [Ares emulato
 * Add the required file to the correct folder on your SD card.
 
 
-## Update Libdragon submodule
-This repo currently uses the `preview` branch as a submodule at a specific commit.
+## Update submodules
 To update to the latest version, use `git submodule update --remote` from the terminal.
 
+### libdragon
+This repo currently uses the `preview` branch as a submodule at a specific commit.
+* To ensure your local instance is building against it, use `cd ./libdragon && make clobber -j && make libdragon tools -j && make install tools-install -j && cd ..`
+
 ## Generate documentation
 Run `doxygen` from the dev container terminal.
 Make sure you fix the warnings before creating a PR!
@@ -57,6 +60,8 @@ Generated documentation is located in the `output/docs` folder and auto-publishe
 Once merged, they can be viewed [here](https://polprzewodnikowy.github.io/N64FlashcartMenu/)
 
 ### Test generated docs in the dev-container
+Testing the documentation locally allows you to preview changes and ensure everything renders correctly before submitting your changes.
+
 Install Prerequisites:
 ```bash
 apt-get install ruby-full build-essential zlib1g-dev

diff --git a/libdragon b/libdragon