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
## Aims
2023-02-27 00:59:02 +01:00
* Support as many N64 FlashCarts as possible.
2023-07-30 21:30:19 +02:00
* Be open source, using permissive licensed third party licensed libraries.
* Be testable, using unit and smoke tests in ares emulated environment.
2023-02-27 00:59:02 +01:00
* Encourage active development from community members and N64 FlashCart owners.
2023-07-30 21:30:19 +02:00
* Support as many common mods and features as possible.
2023-03-01 03:47:08 +01:00
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-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-07-30 21:30:19 +02:00
## Getting started
2023-02-22 19:11:49 +01:00
2023-09-08 21:49:50 +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-02-22 19:11:49 +01:00
### SC64
2023-09-08 21:49:50 +02:00
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-02-22 19:11:49 +01:00
2023-08-18 01:20:53 +02:00
### ED64 & ED64P
2023-07-30 21:30:19 +02:00
Currently not supported, but there is an aim to do so.
The aim is to replace [Altra64 ](https://github.com/networkfusion/altra64 ) and [ED64-UnofficialOS ](https://github.com/n64-tools/ED64-UnofficialOS-binaries ).
### Common to all
2023-08-08 00:15:42 +02:00
2023-07-26 17:55:23 +02: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.
Each file must be named according to the 2 letter ROM ID. e.g. for goldeneye, this would be `GE.png` .
A known set of PNG files can be downloaded [here ](https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w ).
2023-07-26 17:55:23 +02:00
2023-08-08 00:15:42 +02:00
#### Emulator support
2023-08-20 20:58:34 +02:00
Emulators should be added to the `/emulators` directory on the SD card.
2023-08-05 15:56:10 +02:00
2023-08-20 20:58:34 +02:00
Menu currently supports the following emulators and associated ROM file names:
- **NES**: [neon64v2 ](https://github.com/hcs64/neon64v2 ) by *hcs64* - `neon64bu.rom`
- **SNES**: [sodium64 ](https://github.com/Hydr8gon/sodium64 ) by *Hydr8gon* - `sodium64.z64`
- **Game Boy** / **GB Color** : [gb64 ](https://lambertjamesd.github.io/gb64/romwrapper/romwrapper.html ) by *lambertjamesd* - `gb.v64` / `gbc.v64`
Update emulator load display (#46)
<!--- Provide a general summary of your changes in the Title above -->
## Description
<!--- Describe your changes in detail -->
Update emulator load display to be, well, better.
Add TotalSMS (not tested, however, shows that the emulator is not
found.)
Fix rolling release for new forks.
## 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 -->
## 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)
- [ ] 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>
2023-08-28 17:19:51 +02:00
- **Sega Master System ** / **Sega Game Gear** / ** Sg1000 ** : [TotalSMS ](https://github.com/ITotalJustice/TotalSMS ) - `TotalSMS.z64`
2023-08-05 15:56:10 +02:00
2023-02-22 19:11:49 +01:00
# Developer documentation
**Work in progress!**
2023-02-14 22:26:40 +01:00
2023-02-28 19:30:10 +01:00
You can use a dev container in VSCode to ease development.
2023-06-04 17:57:31 +02:00
## To deploy:
2023-07-30 21:30:19 +02:00
### SC64
2023-07-09 00:52:39 +02:00
* Download the deployer [here ](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.16.0/sc64-deployer-windows-v2.16.0.zip )
2023-06-04 17:57:31 +02:00
* Extract and place `sc64deployer.exe` in the `tools/sc64` directory.
2023-07-09 00:52:39 +02:00
Make sure that your firmware is compatible (currently v2.16.0+)
See: https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.16.0/docs/00_quick_startup_guide.md#firmware-backupupdate
2023-06-04 17:57:31 +02:00
2023-07-30 21:30:19 +02:00
#### From the devcontainer
2023-06-04 17:57:31 +02:00
It is not currently possible to directly communicate with USB devices.
BUT, as a work around you can use a proxy TCP/IP connection
Set up a proxy: open a terminal window, `cd ./tools/sc64` and then `./sc64deployer.exe server`
2023-07-30 21:30:19 +02:00
Then in the dev container, use `make run` or `make run-debug`
2023-06-04 17:57:31 +02:00
2023-07-30 21:30:19 +02:00
#### From your host (Windows) OS
2023-06-04 17:57:31 +02:00
* Run `./localdeploy.bat` from the terminal
Toggle the N64 power switch to load the ROM.
2023-02-27 00:14:51 +01:00
`ms-vscode.makefile-tools` will help (installed automatically in dev container).
TODO: it does not yet work with `F5` : see https://devblogs.microsoft.com/cppblog/now-announcing-makefile-support-in-visual-studio-code/
2023-03-13 01:46:13 +01:00
WORKAROUND: in the dev container terminal, use make directly, i.e.: `make`
The ROM can be found in the `output` directory.
2023-02-27 00:14:51 +01:00
2023-08-05 01:37:09 +02:00
NOTE: a "release" version of the SC64 menu is called `sc64menu.n64` and can be created for when you want to add it directly to the SDCard. This is generated by running `make all` or running `make sc64` .
2023-06-04 17:57:31 +02:00
2023-07-09 00:52:39 +02:00
# Update Libdragon submodule
2023-06-04 17:57:31 +02:00
This repo currently uses the `unstable` branch as a submodule at a specific commit.
To update to the latest version, use `git submodule update --remote ` from the terminal.
2023-07-09 00:52:39 +02:00
# Generate documentation
Run `doxygen` from the dev container terminal.
Make sure you fix the warnings before creating a PR!
2023-08-05 01:37:09 +02:00
Generated documentation is located in `output/docs` folder.
2023-07-26 18:43:08 +02:00
2023-08-20 20:58:34 +02:00
# Open source software and licenses used
- [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)