mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-04-05 23:56:53 +02:00
1a9e292598
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Reworks and splits the documentation. ## 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 --> Improves documentation to be more readable. ## How Has This Been Tested? <!-- (if applicable) --> <!--- Please describe in detail how you tested your sample/changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> ## Screenshots <!-- (if appropriate): --> ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Improvement (non-breaking change that adds a new feature) - [ ] Bug fix (fixes an issue) - [ ] 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: <!--- 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! --> - [ ] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] 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 Based on the comprehensive summary, here are the release notes: - **New Features** - Added ROM history and favorites functionality - Introduced tabbed interface for file browsing - Implemented ROM information descriptions - Added support for ROM configuration overrides - Enhanced menu settings management - **Documentation** - Expanded user guide and documentation - Added sections on ROM patches, controller PAKs, and emulator support - Improved flashcart and menu customization instructions - **Chores** - Updated documentation structure - Refined code organization and naming conventions - Updated subproject references <!-- end of auto-generated comment: release notes by coderabbit.ai -->
N64 Flashcart Menu
An open source menu for N64 flashcarts and aims to support as many as possible. The menu is not affiliated with any partuclar flashcart and does not necessarily expose all capable firmware features.
This project considers flashcart sellers that include this menu or copyrighted ROM's as part of their product offering as licence offenders which may result in future action.
Flashcart Supported
This menu aims to support as many N64 flashcarts as possible. The current state is:
Supported
- SummerCart64
- 64Drive
Work in Progress (pre-release only)
- ED64 (X and V series)
- ED64P (clones)
Not planned
- Doctor V64
- PicoCart
- DaisyDrive
Current (notable) menu features
- Fully Open Source.
- Loads all known N64 games, even if they are byteswapped.
- Fully emulates the 64DD and loads 64DD disks (SummerCart64 only).
- Emulator support (NES, SNES, GB, GBC, SMS, GG, CHF) ROMs.
- N64 ROM box art 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.
- ROM information descriptions.
- ROM history and favorites (pre-release only).
Documentation
Please take a moment to browse the current documentation:
Index
Aims
- Support as many N64 Flashcarts as possible.
- Be open source, using permissively licensed third-party libraries.
- Be testable in an emulated environment (Ares).
- Encourage active development from community members and N64 FlashCart owners.
- Support as many common mods and features as possible (flashcart dependent).
Flashcart specific
SC64
- Ensure the cart has the latest firmware installed.
- Download the latest
sc64menu.n64file from the releases page, then put it in the root directory of your SD card.
64drive
- Ensure the cart has the latest firmware installed.
- Download the latest
menu.binfile from the releases page, then put it in the root directory of your SD card.
ED64 - WIP - UNTESTED AND UNSUPPORTED - USE AT OWN RISK
Currently not supported, but work is in progress (See PRs). 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 / ED64-OfficialOS.
Download the OS64.v64 ROM from the latest [action run - assets] and place it in the /ED64 folder.
ED64 (X series)
The aim is to reach feature parity with OS for now.
Download the OS64.v64 ROM from the latest [action run - assets] and place it in the /ED64 folder.
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
Open source software and licenses used
libraries
- libdragon (UNLICENSE License)
- libspng (BSD 2-Clause License)
- mini.c (BSD 2-Clause License)
- minimp3 (CC0 1.0 Universal)
- miniz (MIT License)
Sounds
See License for the following sounds:
- Cursor sound by Skyscraper_seven (Free to use)
- Actions (Enter, Back) sound by Liecio (Free to use)
- Error sound by Universfield (Free to use)