Merge branch 'develop' into improve-rom-info

Author: networkfusion

.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 && \

Makefile

@@ -97,7 +97,7 @@ FILESYSTEM = \
 
 $(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-7F -r 80-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))

README.md

@@ -32,7 +32,7 @@ An open source menu for N64 flashcarts.
 ## Documentation
 * [Getting started guide](./docs/00_getting_started_sd.md)
 * [Menu controls](./docs/01_menu_controls.md)
-* [Menu customizations](./docs/07_menu_customizations.md)
+* [Menu customization](./docs/07_menu_customization.md)
 * [Developer guide](./docs/99_developer_guide.md)
 
 ## Video showcase (as of Oct 12 2023)
@@ -53,27 +53,36 @@ These features are subject to change:
 
 ### 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.
-NOTE: to return to the menu, hold joypad `start` button whilst powering on the console. 
+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.
-
+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`.
 
-**Note1:** Excluding the region ID may show the wrong boxart.
-**Note2:** For future support, boxart sprites should also include: `boxart_back.png`, `boxart_top.png`, `boxart_bottom.png`, `boxart_left.png`, `boxart_right.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)
@@ -117,14 +126,14 @@ If required, you can manually adjust the file on the SD card using your computer
 
 ### 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)).
-NOTE: The menu may be able to load ROM's but not perform saves and may break existing ones..
+**Warning**: The menu may be able to load ROMs but cannot guarantee save functionality. Existing saves may be corrupted.
 
 #### 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, in the meantime use the official [OS](https://krikzz.com/pub/support/everdrive-64/x-series/OS/) instead.
+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.

docs/00_getting_started_sd.md

@@ -1,6 +1,9 @@
 ## First time setup of SD card
 
-Using your PC, insert the SD card and ensure it is formatted for compatibility with your flashcart
+### 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.

docs/01_menu_controls.md

@@ -7,7 +7,7 @@ Use the C-Up and C-Down buttons
 ### DD ROMs
 
 #### Expansion Disks
-To load an expansion disk (e.g. F-Zero X) browse to the N64 ROM and load it (but not start it) and then browse to the DD expansion file and press the `R` button.
+To load an expansion disk (e.g. F-Zero X) browse to the N64 ROM and load it (but not start it) and then browse to the DD expansion file and press the `L` or `Z` button.
 
 #### Disk swapping
 This feature is not currently available in the menu.

libdragon

@@ -82,6 +82,31 @@ static bool d64_has_feature (flashcart_features_t feature) {
     }
 }
 
+/**
+ * @brief Retrieves the firmware version of the 64drive device.
+ *
+ * The firmware version is returned as a flashcart_firmware_version_t structure, with each field
+ * including the major, minor, and revision numbers.
+ * The major version is set to 1 for 64drive variant A, and 2 for 64drive variant B.
+ *
+ * @return A flashcart_firmware_version_t structure containing the firmware version information.
+ */
+static flashcart_firmware_version_t d64_get_firmware_version (void) {
+    flashcart_firmware_version_t version_info;
+
+    d64_ll_get_version(&device_variant, &version_info.minor, &version_info.revision);
+
+    if (device_variant == DEVICE_VARIANT_A) {
+        version_info.major = 1;
+    } else if (device_variant == DEVICE_VARIANT_B) {
+        version_info.major = 2;
+    } else {
+        version_info.major = 0;
+    }
+
+    return version_info;
+}
+
 static flashcart_err_t d64_load_rom (char *rom_path, flashcart_progress_callback_t *progress) {
     FIL fil;
     UINT br;
@@ -277,6 +302,7 @@ static flashcart_t flashcart_d64 = {
     .init = d64_init,
     .deinit = d64_deinit,
     .has_feature = d64_has_feature,
+    .get_firmware_version = d64_get_firmware_version,
     .load_rom = d64_load_rom,
     .load_file = d64_load_file,
     .load_save = d64_load_save,

src/flashcart/64drive/64drive.c

@@ -140,6 +140,7 @@ static flashcart_t flashcart_ed64_vseries = {
     .init = ed64_vseries_init,
     .deinit = ed64_vseries_deinit,
     .has_feature = ed64_vseries_has_feature,
+    .get_firmware_version = NULL, // FIXME: show the returned firmware version info.
     .load_rom = ed64_vseries_load_rom,
     .load_file = ed64_vseries_load_file,
     .load_save = ed64_vseries_load_save,

src/flashcart/ed64/ed64_vseries.c

@@ -156,6 +156,10 @@ bool flashcart_has_feature (flashcart_features_t feature) {
     return flashcart->has_feature(feature);
 }
 
+flashcart_firmware_version_t flashcart_get_firmware_version (void) {
+    return flashcart->get_firmware_version();
+}
+
 flashcart_err_t flashcart_load_rom (char *rom_path, bool byte_swap, flashcart_progress_callback_t *progress) {
     flashcart_err_t err;
 

src/flashcart/flashcart.c

@@ -57,6 +57,13 @@ typedef struct {
     uint8_t defect_tracks[16][12];
 } flashcart_disk_parameters_t;
 
+/** @brief Flashcart Firmware version Structure. */
+typedef struct {
+    uint16_t major;
+    uint16_t minor;
+    uint32_t revision;
+} flashcart_firmware_version_t;
+
 typedef void flashcart_progress_callback_t (float progress);
 
 /** @brief Flashcart Structure */
@@ -67,6 +74,8 @@ typedef struct {
     flashcart_err_t (*deinit) (void);
     /** @brief The flashcart feature function */
     bool (*has_feature) (flashcart_features_t feature);
+    /** @brief The flashcart firmware version function */
+    flashcart_firmware_version_t (*get_firmware_version) (void);
     /** @brief The flashcart ROM load function */
     flashcart_err_t (*load_rom) (char *rom_path, flashcart_progress_callback_t *progress);
     /** @brief The flashcart file load function */
@@ -88,6 +97,7 @@ char *flashcart_convert_error_message (flashcart_err_t err);
 flashcart_err_t flashcart_init (const char **storage_prefix);
 flashcart_err_t flashcart_deinit (void);
 bool flashcart_has_feature (flashcart_features_t feature);
+flashcart_firmware_version_t flashcart_get_firmware_version (void);
 flashcart_err_t flashcart_load_rom (char *rom_path, bool byte_swap, flashcart_progress_callback_t *progress);
 flashcart_err_t flashcart_load_file (char *file_path, uint32_t rom_offset, uint32_t file_offset);
 flashcart_err_t flashcart_load_save (char *save_path, flashcart_save_type_t save_type);