Merge branch 'develop' into ed64-xseries

Makefile

@@ -99,7 +99,6 @@ $(SPNG_OBJS): N64_CFLAGS+=-isystem $(SOURCE_DIR)/libs/miniz -DSPNG_USE_MINIZ -fc
 $(FILESYSTEM_DIR)/FiraMonoBold.font64: MKFONT_FLAGS+=-c 1 --size 16 -r 20-7F -r 80-1FF -r 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

README.md

@@ -49,22 +49,45 @@ An open source menu for N64 flashcarts.
 ## Experimental features
 These features are subject to change:
 
-### ROM Boxart
-To use boxart, place PNG files in the `/menu/boxart` folder on the SD card with the following dimensions:
-* Standard covers: 158x112
-* 64DD covers: 129x112
-* Japanese covers: 112x158
-
-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`.
-You can download these boxart packs:
-
-[American Boxart](https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w)
-
-[European Boxart](https://mega.nz/file/O7AjDbRJ#VnVU10dq8HQvBUQptppI6PAcQMb8-Zembqav8WtAQ_M)
-
-[64DD Boxart](https://mega.nz/file/O3JzwD7B#BYl1aV-pbrJ-MxWUbM_K0yGVIRbmSoxJJZqQInRzZyM)
+
+### 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
+
+They will be loaded by directories using each character of the full 4 character Game Code (as identified in the menus 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`.
+
+
+#### 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

docs/00_getting_started_sd.md

@@ -36,7 +36,7 @@ SD:\
 │   │    ├── NDDJ2.n64
 │   │    └── NDXJ0.n64
 │   │    
-│   └── emulators
+│   └── emulators\
 │        ├── neon64bu.rom
 │        ├── sodium64.z64
 │        ├── gb.v64

src/menu/actions.c

@@ -25,8 +25,16 @@ static void actions_clear (menu_t *menu) {
 }
 
 static void actions_update_direction (menu_t *menu) {
-    joypad_8way_t held_dir = joypad_get_direction(JOYPAD_PORT_1, JOYPAD_2D_DPAD | JOYPAD_2D_STICK);
-    joypad_8way_t fast_dir = joypad_get_direction(JOYPAD_PORT_1, JOYPAD_2D_C);
+    joypad_8way_t held_dir;
+    joypad_8way_t fast_dir;
+
+    JOYPAD_PORT_FOREACH (i) {
+        held_dir = joypad_get_direction(i, JOYPAD_2D_DPAD | JOYPAD_2D_STICK);
+        fast_dir = joypad_get_direction(i, JOYPAD_2D_C);
+        if (held_dir != JOYPAD_8WAY_NONE || fast_dir != JOYPAD_8WAY_NONE) {
+            break;
+        }
+    }
 
     if (fast_dir != JOYPAD_8WAY_NONE) {
         held_dir = fast_dir;
@@ -82,7 +90,14 @@ static void actions_update_direction (menu_t *menu) {
 }
 
 static void actions_update_buttons (menu_t *menu) {    
-    joypad_buttons_t pressed = joypad_get_buttons_pressed(JOYPAD_PORT_1);
+    joypad_buttons_t pressed;
+
+    JOYPAD_PORT_FOREACH (i) {
+        pressed = joypad_get_buttons_pressed(i);
+        if (pressed.raw) {
+            break;
+        }
+    }
 
     if (pressed.a) {
         menu->actions.enter = true;
@@ -98,6 +113,12 @@ static void actions_update_buttons (menu_t *menu) {
 }
 
 
+void actions_init (void) {
+    JOYPAD_PORT_FOREACH (port) {
+        joypad_set_rumble_active(port, false);
+    }
+}
+
 void actions_update (menu_t *menu) {
     joypad_poll();
 

src/menu/actions.h

@@ -11,6 +11,7 @@
 #include "menu_state.h"
 
 
+void actions_init (void);
 void actions_update (menu_t *menu);
 
 

src/menu/components.h

@@ -11,6 +11,41 @@
 #include <libdragon.h>
 #include "menu_state.h"
 
+/** @brief File image Enumeration. */
+typedef enum {
+
+    /** @brief Boxart image from the front */
+    IMAGE_BOXART_FRONT,
+
+    /** @brief Boxart image from the back */
+    IMAGE_BOXART_BACK,
+
+    /** @brief Boxart image from the top */
+    IMAGE_BOXART_TOP,
+
+    /** @brief Boxart image from the bottom */
+    IMAGE_BOXART_BOTTOM,
+
+    /** @brief Boxart image from the left side */
+    IMAGE_BOXART_LEFT,
+
+    /** @brief Boxart image from the right side */
+    IMAGE_BOXART_RIGHT,
+
+    /** @brief GamePak image from the front */
+    IMAGE_GAMEPAK_FRONT,
+
+    /** @brief GamePak image from the back */
+    IMAGE_GAMEPAK_BACK,
+
+    /** @brief File image thumbnail */
+    IMAGE_THUMBNAIL,
+
+    /** @brief List end marker */
+    IMAGE_TYPE_END
+
+} file_image_type_t;
+
 
 /**
  * @addtogroup 
@@ -64,7 +99,7 @@ typedef struct {
     surface_t *image;
 } component_boxart_t;
 
-component_boxart_t *component_boxart_init (const char *storage_prefix, char *game_code);
+component_boxart_t *component_boxart_init (const char *storage_prefix, char *game_code, file_image_type_t current_image_view);
 void component_boxart_free (component_boxart_t *b);
 void component_boxart_draw (component_boxart_t *b);
 

src/menu/components/background.c

@@ -98,25 +98,20 @@ static void prepare_background (component_background_t *c) {
         return;
     }
 
-    uint16_t image_center_x = (c->image->width / 2);
-    uint16_t image_center_y = (c->image->height / 2);
-
     // Darken the image
     rdpq_attach(c->image, NULL);
     rdpq_mode_push();
         rdpq_set_mode_standard();
         rdpq_set_prim_color(BACKGROUND_OVERLAY_COLOR);
         rdpq_mode_combiner(RDPQ_COMBINER_FLAT);
         rdpq_mode_blender(RDPQ_BLENDER_MULTIPLY);
-        rdpq_fill_rectangle(
-            0 - (DISPLAY_CENTER_X - image_center_x),
-            0 - (DISPLAY_CENTER_Y - image_center_y),
-            DISPLAY_WIDTH - (DISPLAY_CENTER_X - image_center_x),
-            DISPLAY_HEIGHT - (DISPLAY_CENTER_Y - image_center_y)
-        );
+        rdpq_fill_rectangle(0, 0, c->image->width, c->image->height);
     rdpq_mode_pop();
     rdpq_detach();
 
+    uint16_t image_center_x = (c->image->width / 2);
+    uint16_t image_center_y = (c->image->height / 2);
+
     // Prepare display list
     rspq_block_begin();
     rdpq_mode_push();

src/menu/components/boxart.c

@@ -17,9 +17,9 @@ static void png_decoder_callback (png_err_t err, surface_t *decoded_image, void
 }
 
 
-component_boxart_t *component_boxart_init (const char *storage_prefix, char *game_code) {
+component_boxart_t *component_boxart_init (const char *storage_prefix, char *game_code, file_image_type_t current_image_view) {
     component_boxart_t *b;
-    char file_name[8];
+    char boxart_id_path[8];
 
     if ((b = calloc(1, sizeof(component_boxart_t))) == NULL) {
         return NULL;
@@ -29,21 +29,83 @@ component_boxart_t *component_boxart_init (const char *storage_prefix, char *gam
 
     path_t *path = path_init(storage_prefix, BOXART_DIRECTORY);
 
-    sprintf(file_name, "%.3s.png", game_code);
-    path_push(path, file_name);
-    if (png_decoder_start(path_get(path), BOXART_WIDTH_MAX, BOXART_HEIGHT_MAX, png_decoder_callback, b) == PNG_OK) {
-        path_free(path);
-        return b;
+    sprintf(boxart_id_path, "%c/%c/%c/%c", game_code[0], game_code[1], game_code[2], game_code[3]);
+    path_push(path, boxart_id_path);
+
+    if (!directory_exists(path_get(path))) { // Allow boxart to not specify the region code.
+        path_pop(path);
+    }
+
+    if (directory_exists(path_get(path))) {
+        switch (current_image_view) {
+            case IMAGE_GAMEPAK_FRONT:
+                path_push(path, "gamepak_front.png");
+            case IMAGE_GAMEPAK_BACK:
+                path_push(path, "gamepak_back.png");
+            case IMAGE_BOXART_BACK:
+                path_push(path, "boxart_back.png");
+            case IMAGE_BOXART_LEFT:
+                path_push(path, "boxart_left.png");
+            case IMAGE_BOXART_RIGHT:
+                path_push(path, "boxart_right.png");
+            case IMAGE_BOXART_BOTTOM:
+                path_push(path, "boxart_bottom.png");
+            case IMAGE_BOXART_TOP:
+                path_push(path, "boxart_top.png");
+            default:
+                path_push(path, "boxart_front.png");
+        }
+
+        if (file_exists(path_get(path))) { 
+            if (png_decoder_start(path_get(path), BOXART_WIDTH_MAX, BOXART_HEIGHT_MAX, png_decoder_callback, b) == PNG_OK) {
+                path_free(path);
+                return b;
+            }
+        }
     }
-    path_pop(path);
-
-    // TODO: This is bad, we should only check for 3 letter codes
-    sprintf(file_name, "%.2s.png", game_code + 1);
-    path_push(path, file_name);
-    if (png_decoder_start(path_get(path), BOXART_WIDTH_MAX, BOXART_HEIGHT_MAX, png_decoder_callback, b) == PNG_OK) {
-        path_free(path);
-        return b;
+    else { // compatibility mode
+
+        char file_name[8];
+
+        // reset the directory path used for boxart.
+        path = path_init(storage_prefix, BOXART_DIRECTORY);
+
+        sprintf(file_name, "%c%c%c%c.png", game_code[0], game_code[1], game_code[2], game_code[3]);
+        path_push(path, file_name);
+
+        if (file_exists(path_get(path))) {
+            if (png_decoder_start(path_get(path), BOXART_WIDTH_MAX, BOXART_HEIGHT_MAX, png_decoder_callback, b) == PNG_OK) {
+                path_free(path);
+                return b;
+            }
+        }
+
+        path_pop(path);
+        sprintf(file_name, "%c%c%c.png", game_code[0], game_code[1], game_code[2]);
+        path_push(path, file_name);
+
+        if (file_exists(path_get(path))) {
+            if (file_exists(path_get(path))) {
+                if (png_decoder_start(path_get(path), BOXART_WIDTH_MAX, BOXART_HEIGHT_MAX, png_decoder_callback, b) == PNG_OK) {
+                    path_free(path);
+                    return b;
+                }
+            }
+        }
+        else {
+            path_pop(path);
+
+            sprintf(file_name, "%c%c.png", game_code[1], game_code[2]);
+            path_push(path, file_name);
+            if (file_exists(path_get(path))) {
+                if (png_decoder_start(path_get(path), BOXART_WIDTH_MAX, BOXART_HEIGHT_MAX, png_decoder_callback, b) == PNG_OK) {
+                    path_free(path);
+                    return b;
+                }
+            }
+        }
     }
+    // TODO: return default image.
 
     path_free(path);
     free(b);
@@ -89,4 +151,4 @@ void component_boxart_draw (component_boxart_t *b) {
             BOXART_LOADING_COLOR
         );
     }
-}
+}