2023-11-01 19:47:08 +01:00
![Build ](https://github.com/polprzewodnikowy/N64FlashcartMenu/actions/workflows/build.yml/badge.svg )
2023-07-30 21:30:19 +02:00
# N64 Flashcart Menu
2023-08-18 01:20:53 +02:00
An open source menu for N64 flashcarts.
2023-02-22 19:11:49 +01:00
2024-01-10 18:20:50 +01:00
## Supported Flashcarts
### Fully supported
* SummerCart64
* 64Drive
2024-01-10 18:42:54 +01:00
### Work in Progress
2024-01-10 18:20:50 +01:00
* ED64
* ED64P
2023-02-22 19:11:49 +01:00
2023-08-18 01:20:53 +02:00
## Current (notable) menu features
* Fully Open Source.
2023-08-28 01:58:01 +02:00
* Loads all known N64 games (including iQue and Aleck64 ROMs (even if they are byteswapped)).
2023-10-10 21:52:19 +02:00
* Fully emulates the 64DD and loads 64DD disks (SummerCart64 only).
2023-08-20 20:58:34 +02:00
* Emulator support (NES, SNES, GB, GBC) ROMs.
2023-08-18 01:20:53 +02:00
* N64 ROM box image support.
* Background image (PNG) support.
* Comprehensive ROM save database (including HomeBrew headers).
* Comprehensive ROM information display.
* Real Time Clock support.
* Music playback (MP3).
2023-02-22 19:11:49 +01:00
2024-08-04 18:56:54 +02:00
## Documentation
* [Getting started guide ](./docs/00_getting_started_sd.md )
* [Menu controls ](./docs/01_menu_controls.md )
* [Developer guide ](./docs/99_developer_guide.md )
## Video showcase (as of Oct 12 2023)
2023-09-08 21:49:50 +02:00
2023-11-01 19:33:25 +01:00
[![N64FlashcartMenu Showcase ](http://img.youtube.com/vi/6CKImHTifDA/0.jpg )](http://www.youtube.com/watch?v=6CKImHTifDA "N64FlashcartMenu Showcase (Oct 12 2023)")
2023-10-10 21:12:53 +02:00
2023-10-15 00:08:26 +02:00
2023-11-01 19:33:25 +01:00
## Aims
* Support as many N64 FlashCarts as possible.
* Be open source, using permissive licensed third party licensed libraries.
* Be testable, using unit and smoke tests in ares emulated environment.
* Encourage active development from community members and N64 FlashCart owners.
* Support as many common mods and features as possible.
2023-10-10 21:52:19 +02:00
2023-07-30 21:30:19 +02:00
2024-08-04 18:56:54 +02:00
## Experimental features
These features are subject to change:
2023-08-08 00:15:42 +02:00
2023-11-01 19:33:25 +01:00
### ROM Boxart
2023-08-20 20:58:34 +02:00
To use boxart, you need to place png files of size 158x112 in the folder `/menu/boxart` on the SD card.
2023-09-17 10:38:42 +02:00
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` .
A known set of PNG files using 2 letter ID's can be downloaded [here ](https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w ).
2023-07-26 17:55:23 +02:00
2023-11-01 19:33:25 +01:00
2023-12-17 21:57:45 +01:00
### Menu Settings
The Menu creates a `config.ini` file in `sd:/menu/` which contains various settings that are used by the menu.
If required, you can manually adjust the file on the SD card using your computer.
2023-02-22 19:11:49 +01:00
2023-11-01 19:33:25 +01:00
2024-08-04 18:56:54 +02:00
## Flashcart specific
2023-11-01 19:33:25 +01:00
2024-08-04 18:56:54 +02:00
### SC64
* Ensure the cart has the latest [firmware ](https://github.com/Polprzewodnikowy/SummerCart64/releases/latest ) installed.
* Download the latest `sc64menu.n64` file from the releases page, then put it in the root directory of your SD card.
2023-11-01 19:33:25 +01:00
2024-08-04 18:56:54 +02:00
### 64drive
* Ensure the cart has the latest [firmware ](https://64drive.retroactive.be/support.php ) installed.
* Download the latest `menu.bin` file from the releases page, then put it in the root directory of your SD card.
2023-11-01 19:33:25 +01:00
2024-08-04 18:56:54 +02:00
### ED64 & ED64P
2023-11-01 19:33:25 +01:00
Currently not supported, but work is in progress (See [PR's ](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls )).
The aim is to replace [Altra64 ](https://github.com/networkfusion/altra64 ) and [ED64-UnofficialOS ](https://github.com/n64-tools/ED64-UnofficialOS-binaries ).
2023-08-20 20:58:34 +02:00
# Open source software and licenses used
2024-08-04 18:56:54 +02:00
* [libdragon ](https://github.com/DragonMinded/libdragon ) (UNLICENSE License)
* [libspng ](https://github.com/randy408/libspng ) (BSD 2-Clause License)
* [mini.c ](https://github.com/univrsal/mini.c ) (BSD 2-Clause License)
* [minimp3 ](https://github.com/lieff/minimp3 ) (CC0 1.0 Universal)
* [miniz ](https://github.com/richgel999/miniz ) (MIT License)