mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2025-01-11 01:29:07 +01:00

Go to file

<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
Improves 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 -->
Helps users.

## 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>

2025-01-10 23:53:21 +00:00

.devcontainer

[main] Next release changes (#162 )

2024-12-30 15:08:28 +00:00

.github

[main] Add changelog (#188 )

2025-01-10 21:59:19 +00:00

assets

[main] Next release changes (#162 )

2024-12-30 15:08:28 +00:00

docs

[main] Readme improvements (#191 )

2025-01-10 23:53:21 +00:00

filesystem

Use stdio calls for file/directory interaction instead of fatfs (#95 )

2024-04-24 02:45:09 +02:00

libdragon @ d95e9c0dea

[main] Hotfix display issues (#189 )

2025-01-10 22:18:46 +00:00

src

[main] Hotfix display issues (#189 )

2025-01-10 22:18:46 +00: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

[main] Next release changes (#162 )

2024-12-30 15:08:28 +00:00

.gitmodules

Use stdio calls for file/directory interaction instead of fatfs (#95 )

2024-04-24 02:45:09 +02:00

CHANGELOG.md

[main] Readme improvements (#191 )

2025-01-10 23:53:21 +00: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

[main] Next release changes (#162 )

2024-12-30 15:08:28 +00:00

README.md

[main] Readme improvements (#191 )

2025-01-10 23:53:21 +00:00

remotedeploy.sh

Added USB debug commands handling + file_get_sectors refactor

2023-09-04 21:09:46 +02:00

README.md

An open source menu for N64 flashcarts.

Supported Flashcarts

This menu aims to support as many N64 flashcarts as possible.

Fully supported

SummerCart64
64Drive

Work in Progress

ED64
ED64P

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.

Documentation

Video showcase (as of Oct 12 2023)

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.

Experimental features

These features are subject to change:

N64 ROM autoload

To use the autoload function, while on the N64 ROM information display, press the R button on your joypad and select the Set ROM to autoload option. When you restart the console, it will now only load the selected ROM rather than the menu. The autoload setting is stored in config.ini and persists until changed. This feature may slightly increase boot time as the menu needs to check for the Start button state. NOTE: To return to the menu, hold the joypad Start button while powering on the console.

GamePak sprites

To use N64 GamePak sprites, place PNG files within the sd:/menu/boxart/ folder.

Supported sprites

These must be PNG files that use the following dimensions:

Standard N64 GamePak boxart sprites: 158x112
Japanese N64 GamePak boxart sprites: 112x158
64DD boxart sprites: 129x112

Supported PNG formats:

RGB/RGBA color formats
8-bit color depth

They will be loaded by directories using each character (case-sensitive) of the full 4 character Game Code (as identified in the menu ROM information).
i.e. for GoldenEye NTSC USA (NGEE), this would be sd:/menu/boxart/N/G/E/E/boxart_front.png.
i.e. for GoldenEye PAL (NGEP), this would be sd:/menu/boxart/N/G/E/P/boxart_front.png.

To improve compatibility between regions (as a fallback), you may exclude the region ID (last matched directory) for GamePaks to match with 3 letter IDs instead:
i.e. for GoldenEye, this would be sd:/menu/boxart/N/G/E/boxart_front.png.

Warning: Excluding the region ID may show the wrong boxart. Note: For future support, boxart sprites should also include:

boxart_back.png
boxart_top.png
boxart_bottom.png
boxart_left.png
boxart_right.png

As a starting point, here is a link to a boxart pack following the new structure, including boxart_front.png and fallback images:

Recommended Boxart

Compatibility mode

If you cannot yet satisfy the correct boxart layout, The menu still has deprecated support for filenames containing the Game ID.

Note: This will add a noticeable delay for displaying parts of the menu.

Each file must be named according to the 2,3 or 4 letter GamePak ID (matched in this order). i.e.

for GoldenEye 4 letters, this would be sd:/menu/boxart/NGEE.png and/or sd:/menu/boxart/NGEP.png.
for GoldenEye 3 letters, this would be sd:/menu/boxart/NGE.png.
for GoldenEye 2 letters, this would be sd:/menu/boxart/GE.png.

As a starting point, here are some links to boxart image packs:

The Menu creates a config.ini file in sd:/menu/ which contains various settings that are used by the menu. These can be updated using the settings editor, but if required, you can also 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 - 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)

X Series support is currently awaiting fixes. Please use the official OS for now.

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

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)

Languages

C 97.8%

Makefile 1.2%

Assembly 0.5%

Dockerfile 0.2%

Batchfile 0.2%

README.md

N64 Flashcart Menu

Supported Flashcarts

Fully supported

Work in Progress

Current (notable) menu features

Documentation

Video showcase (as of Oct 12 2023)

Aims

Experimental features

N64 ROM autoload

GamePak sprites

Supported sprites

Compatibility mode

Menu Settings

Flashcart specific

SC64

64drive

ED64 - WIP - UNTESTED AND UNSUPPORTED - USE AT OWN RISK

ED64 (Vseries)

ED64 (X series)

ED64 (P clone)

Open source software and licenses used

Sounds