Merge branch 'develop' into hdmi-mod-pal60

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

@@ -85,30 +85,6 @@ SOUNDS = \
 	error.wav \
 	settings.wav
 
-JOYPAD_IMAGES = \
-	joypad_a.png \
-	joypad_b.png \
-	joypad_c_down.png \
-	joypad_c_left.png \
-	joypad_c_right.png \
-	joypad_c_up.png \
-	joypad_d_down.png \
-	joypad_d_left.png \
-	joypad_d_right.png \
-	joypad_d_up.png \
-	joypad_l.png \
-	joypad_r.png \
-	joypad_start.png \
-	joypad_z.png
-# joypad_j_east.png \
-# joypad_j_north.png \
-# joypad_j_northeast.png \
-# joypad_j_northwest.png \
-# joypad_j_south.png \
-# joypad_j_southeast.png \
-# joypad_j_southwest.png \
-# joypad_j_west.png \
-
 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))
@@ -117,11 +93,11 @@ DEPS = $(OBJS:.o=.d)
 FILESYSTEM = \
 	$(addprefix $(FILESYSTEM_DIR)/, $(notdir $(FONTS:%.ttf=%.font64))) \
 	$(addprefix $(FILESYSTEM_DIR)/, $(notdir $(SOUNDS:%.wav=%.wav64))) \
-	$(addprefix $(FILESYSTEM_DIR)/, $(notdir $(JOYPAD_IMAGES:%.png=%.sprite)))
+	$(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-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))
@@ -134,7 +110,7 @@ $(FILESYSTEM_DIR)/%.wav64: $(ASSETS_DIR)/sounds/%.wav
 	@echo "    [AUDIO] $@"
 	@$(N64_AUDIOCONV) $(AUDIOCONV_FLAGS) -o $(FILESYSTEM_DIR) "$<"
 
-$(FILESYSTEM_DIR)/%.sprite: $(ASSETS_DIR)/images/joypad/%.png
+$(FILESYSTEM_DIR)/%.sprite: $(ASSETS_DIR)/images/%.png
 	@echo "    [SPRITE] $@"
 	@$(N64_MKSPRITE) $(MKSPRITE_FLAGS) -o $(dir $@) "$<"
 

README.md

@@ -18,7 +18,7 @@ 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, SMS, GG) 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).
@@ -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.