The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2024-11-21 18:19:19 +01:00
Code Issues Packages Projects Releases Wiki Activity
Universal N64 flashcart menu for wide variety of devices
236 Commits 3 Branches 2 Tags 7.6 MiB
C 97.7%
Makefile 1.2%
Assembly 0.5%
Dockerfile 0.3%
Batchfile 0.2%
Other 0.1%
f10097de70
Go to file
Robin Jones f10097de70
Improve documentation (#128) 
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
Split documentation into chunks that users can understand.
Improve them to be more idiot proof!

## 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 -->
Allows an easier way to point people towards specific documentation.
#127 
#76 

## 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>
2024-08-04 17:56:54 +01:00
.devcontainer Use stdio calls for file/directory interaction instead of fatfs (#95) 2024-04-24 02:45:09 +02:00
.github Update PULL_REQUEST_TEMPLATE.md 2024-08-01 15:31:23 +01:00
assets Moved assets to the DragonFS 2023-12-08 19:49:50 +01:00
docs Improve documentation (#128) 2024-08-04 17:56:54 +01:00
filesystem Use stdio calls for file/directory interaction instead of fatfs (#95) 2024-04-24 02:45:09 +02:00
libdragon@af650428e9 Update libdragon submodule (#102) 2024-05-19 14:57:12 +01:00
src Improve rumble default state (#117) 2024-07-03 23:12:18 +01:00
tools/sc64 Moved assets to the DragonFS 2023-12-08 19:49:50 +01:00
.clang-format clang-format WIP 2024-04-26 23:04:19 +02:00
.gitattributes Mark src/libs folder as vendored code 2023-07-26 12:43:18 +02:00
.gitignore Improve documentation (#128) 2024-08-04 17:56:54 +01:00
.gitmodules Use stdio calls for file/directory interaction instead of fatfs (#95) 2024-04-24 02:45:09 +02:00
Doxyfile Improve documentation (#128) 2024-08-04 17:56:54 +01:00
localdeploy.bat Added USB debug commands handling + file_get_sectors refactor 2023-09-04 21:09:46 +02:00
Makefile Cheats support (backend only) (#94) 2024-05-05 00:19:20 +02:00
README.md Improve documentation (#128) 2024-08-04 17:56:54 +01:00
remotedeploy.sh Added USB debug commands handling + file_get_sectors refactor 2023-09-04 21:09:46 +02:00

README.md

Build

N64 Flashcart Menu

An open source menu for N64 flashcarts.

Supported Flashcarts

Fully supported

  • SummerCart64
  • 64Drive

Work in Progress

  • ED64
  • ED64P

Current (notable) menu features

  • 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) ROMs.
  • 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).

Documentation

Video showcase (as of Oct 12 2023)

N64FlashcartMenu Showcase

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.

Experimental features

These features are subject to change:

ROM Boxart

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, 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.

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.

Flashcart specific

SC64

  • Ensure the cart has the latest firmware installed.
  • Download the latest sc64menu.n64 file 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.bin file from the releases page, then put it in the root directory of your SD card.

ED64 & ED64P

Currently not supported, but work is in progress (See PR's).

The aim is to replace Altra64 and ED64-UnofficialOS.

Open source software and licenses used