mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-04-07 05:56:34 +02:00
22515a6fdf
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> ### Release Notes 2025-03-31 - **New Features** - Introduced tabs in main menu for ROM favorites and recently played ROM history. - Introduced first run check to ensure users are aware of latest changes. - Introduced ability to turn off GUI loading bar. - BETA_FEATURE: Introduces ROM descriptions from files. - BETA_FEATURE: Enabled setting for fast ROM reboots on the SC64. - Add macOS metadata to hidden files. - Added settings schema version for future change versioning. - Added setting for PAL60 compatibility mode (see breaking changes). - BETA_FEATURE: Added setting for line doublers that need progressive output, enable using "force_progressive_scan" setting in `config.ini`. - **Bug Fixes** - Menu sound FX issues (hissing, popping and white noise). - RTC not showing or setting correct date parameters in certain circumstances. - GB / GBC emulator not saving in certain circumstances. - **Documentation** - Re-orginised and improved user documentation. - Added a lot of doxygen compatible code comments. - Added project license. - **Refactor** - RTC subsystem (align with libDragon improvements). - Boxart images (Deprecates old boxart image folder layout). - Settings (PAL60 compatibility, schema version, fast reboot, first run, progress bar). - **Other** - Updated libDragon SDK. - Updated miniz library. ### Breaking changes * GB /GBC emulator changed save type to SRAM (from FRAM) to improve compatibility with Summercart64 (which only uses H/W compatible FRAM), this may break your ability to load existing saves. * For similar PAL60 functionality, you may need to also enable the new "pal60_compatibility_mode" setting in `config.ini`. ### Current known Issues * The RTC UI requires improvement (awaiting UI developer). * Menu sound FX may not work properly when a 64 Disk Drive is also attached (work around: turn sound FX off). * Fast Rebooting a 64DD disk once will result in a blank screen. Twice will return to menu. This is expected until disk swapping is implemented. * MP3 Player crashes menu if the MP3 file's sample rate is less than 44100 hz. ### Deprecation notices * Autoload ROM's will be deprecated in favor of Fast Reboot in a future menu version. * Old boxart images using filenames for game ID is deprecated and the compatibility mode will be removed in a future release. ## 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 --> Works towards next release to main. ## How Has This Been Tested? On a SummerCart64 ## Screenshots <!-- (if appropriate): --> ## 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 - [x] 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 & Enhancements** - Introduced dynamic history and favorites management for ROM and disk selections with a new tabbed interface. - Added support for autoloading ROMs, 64DD disk emulation, emulator integration, MP3 playback, and custom background images. - Expanded settings options—including PAL60 compatibility and fast ROM reboots—and improved startup behavior with an introductory credits display. - Added a feature to toggle the loading progress bar and enhanced the display of ROM information. - Implemented a bookkeeping system for managing history and favorites, along with new context menu entries for toggling settings. - Added a new user guide for N64FlashcartMenu and introduced a FAQ section addressing common issues. - Enhanced the user interface with new tabs for managing ROM favorites and recently played ROMs. - Introduced first run checks for user awareness of changes. - **Bug Fixes** - Resolved issues related to menu sound effects, RTC date parameters, and saving functionality in the GB/GBC emulator. - **Documentation** - Overhauled and expanded user guides, FAQs, and README materials to provide clearer instructions on ROM configuration, cheats, flashcart support, and new features. - Added detailed documentation comments throughout the codebase to improve clarity and maintainability, including updates to the pull request template and license information. - Included a new section in the CHANGELOG detailing various updates and breaking changes. <!-- 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> Co-authored-by: Ross Gouldthorpe <github@thegouldfish.co.uk> Co-authored-by: Víctor "IlDucci <IlDucci@users.noreply.github.com> Co-authored-by: XLuma <39510265+XLuma@users.noreply.github.com> Co-authored-by: thekovic <72971433+thekovic@users.noreply.github.com>
194 lines
4.9 KiB
Makefile
194 lines
4.9 KiB
Makefile
PROJECT_NAME = N64FlashcartMenu
|
|
|
|
.DEFAULT_GOAL := all
|
|
|
|
SOURCE_DIR = src
|
|
ASSETS_DIR = assets
|
|
FILESYSTEM_DIR = filesystem
|
|
BUILD_DIR = build
|
|
OUTPUT_DIR = output
|
|
|
|
MENU_VERSION ?= "Rolling release"
|
|
BUILD_TIMESTAMP = "$(shell TZ='UTC' date "+%Y-%m-%d %H:%M:%S %:z")"
|
|
|
|
include $(N64_INST)/include/n64.mk
|
|
|
|
N64_ROM_SAVETYPE = none
|
|
N64_ROM_RTC = 1
|
|
N64_ROM_REGIONFREE = 1
|
|
N64_ROM_REGION = E
|
|
|
|
N64_CFLAGS += -iquote $(SOURCE_DIR) -iquote $(ASSETS_DIR) -I $(SOURCE_DIR)/libs -flto=auto $(FLAGS)
|
|
|
|
SRCS = \
|
|
main.c \
|
|
boot/boot.c \
|
|
boot/cheats.c \
|
|
boot/cic.c \
|
|
boot/reboot.S \
|
|
flashcart/64drive/64drive_ll.c \
|
|
flashcart/64drive/64drive.c \
|
|
flashcart/flashcart_utils.c \
|
|
flashcart/ed64/ed64_vseries.c \
|
|
flashcart/ed64/ed64_xseries.c \
|
|
flashcart/flashcart.c \
|
|
flashcart/sc64/sc64_ll.c \
|
|
flashcart/sc64/sc64.c \
|
|
libs/libspng/spng/spng.c \
|
|
libs/mini.c/src/mini.c \
|
|
libs/miniz/miniz_tdef.c \
|
|
libs/miniz/miniz_tinfl.c \
|
|
libs/miniz/miniz_zip.c \
|
|
libs/miniz/miniz.c \
|
|
menu/actions.c \
|
|
menu/bookkeeping.c \
|
|
menu/cart_load.c \
|
|
menu/disk_info.c \
|
|
menu/fonts.c \
|
|
menu/hdmi.c \
|
|
menu/menu.c \
|
|
menu/mp3_player.c \
|
|
menu/path.c \
|
|
menu/png_decoder.c \
|
|
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/ui_components/tabs.c \
|
|
menu/usb_comm.c \
|
|
menu/views/browser.c \
|
|
menu/views/credits.c \
|
|
menu/views/error.c \
|
|
menu/views/fault.c \
|
|
menu/views/file_info.c \
|
|
menu/views/history_favorites.c \
|
|
menu/views/image_viewer.c \
|
|
menu/views/text_viewer.c \
|
|
menu/views/load_disk.c \
|
|
menu/views/load_emulator.c \
|
|
menu/views/load_rom.c \
|
|
menu/views/music_player.c \
|
|
menu/views/startup.c \
|
|
menu/views/system_info.c \
|
|
menu/views/settings_editor.c \
|
|
menu/views/rtc.c \
|
|
menu/views/flashcart_info.c \
|
|
utils/fs.c
|
|
|
|
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 $(SOUNDS:%.wav=%.wav64))) \
|
|
$(addprefix $(FILESYSTEM_DIR)/, $(notdir $(IMAGES:%.png=%.sprite)))
|
|
|
|
$(MINIZ_OBJS): N64_CFLAGS+=-DMINIZ_NO_TIME -Wno-unused-function -fcompare-debug-second
|
|
$(SPNG_OBJS): N64_CFLAGS+=-isystem $(SOURCE_DIR)/libs/miniz -DSPNG_USE_MINIZ -fcompare-debug-second
|
|
$(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)/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
|
|
$(BUILD_DIR)/menu/views/credits.o: FLAGS+=-DMENU_VERSION=\"$(MENU_VERSION)\" -DBUILD_TIMESTAMP=\"$(BUILD_TIMESTAMP)\"
|
|
|
|
$(BUILD_DIR)/$(PROJECT_NAME).elf: $(OBJS)
|
|
|
|
disassembly: $(BUILD_DIR)/$(PROJECT_NAME).elf
|
|
@$(N64_OBJDUMP) -S $< > $(BUILD_DIR)/$(PROJECT_NAME).lst
|
|
.PHONY: disassembly
|
|
|
|
$(PROJECT_NAME).z64: N64_ROM_TITLE=$(PROJECT_NAME)
|
|
$(PROJECT_NAME).z64: $(BUILD_DIR)/$(PROJECT_NAME).dfs
|
|
|
|
$(@info $(shell mkdir -p ./$(OUTPUT_DIR) &> /dev/null))
|
|
|
|
$(OUTPUT_DIR)/$(PROJECT_NAME).n64: $(PROJECT_NAME).z64
|
|
@mv $< $@
|
|
|
|
64drive: $(OUTPUT_DIR)/$(PROJECT_NAME).n64
|
|
@cp $< $(OUTPUT_DIR)/menu.bin
|
|
.PHONY: 64drive
|
|
|
|
ed64: $(OUTPUT_DIR)/$(PROJECT_NAME).n64
|
|
@cp $< $(OUTPUT_DIR)/OS64.v64
|
|
.PHONY: ed64
|
|
|
|
ed64-clone: $(OUTPUT_DIR)/$(PROJECT_NAME).n64
|
|
@cp $< $(OUTPUT_DIR)/OS64P.v64
|
|
.PHONY: ed64-clone
|
|
|
|
sc64: $(OUTPUT_DIR)/$(PROJECT_NAME).n64
|
|
@cp $< $(OUTPUT_DIR)/sc64menu.n64
|
|
.PHONY: sc64
|
|
|
|
all: $(OUTPUT_DIR)/$(PROJECT_NAME).n64 64drive ed64 ed64-clone sc64
|
|
.PHONY: all
|
|
|
|
clean:
|
|
@rm -f ./$(FILESYSTEM)
|
|
@find ./$(FILESYSTEM_DIR) -type d -empty -delete
|
|
@rm -rf ./$(BUILD_DIR) ./$(OUTPUT_DIR)
|
|
.PHONY: clean
|
|
|
|
format:
|
|
@find ./$(SOURCE_DIR) \
|
|
-path \./$(SOURCE_DIR)/libs -prune \
|
|
-o -iname *.c -print \
|
|
-o -iname *.h -print \
|
|
| xargs clang-format -i
|
|
|
|
run: $(OUTPUT_DIR)/$(PROJECT_NAME).n64
|
|
ifeq ($(OS),Windows_NT)
|
|
./localdeploy.bat
|
|
else
|
|
./remotedeploy.sh
|
|
endif
|
|
.PHONY: run
|
|
|
|
run-debug: $(OUTPUT_DIR)/$(PROJECT_NAME).n64
|
|
ifeq ($(OS),Windows_NT)
|
|
./localdeploy.bat /d
|
|
else
|
|
./remotedeploy.sh -d
|
|
endif
|
|
.PHONY: run-debug
|
|
|
|
# test:
|
|
# TODO: run tests
|
|
|
|
.FORCE:
|
|
|
|
-include $(DEPS)
|