The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2024-11-22 18:49:20 +01:00
Code Issues Packages Projects Releases Wiki Activity
a35c6bdec7
N64FlashcartMenu/README.md
Suprapote 68cab6d40e
64dd & Japanese covers (#126) 
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

This adds in the 64DD disk load menu to visualize the game box.
I also created a European and 64DD boxart packs

## 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 boxart image support.

## 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. -->
Tested on a local SC64

## Screenshots
<!-- (if appropriate): -->


## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [x] 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>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit


- **New Features**
- Enhanced instructions in the README for boxart dimensions and
resources.
- Improved handling of box art rendering for various formats in the
menu.
- New functionality for displaying box art during disk loading in the
menu interface, including resource management for cleanup.

- **Bug Fixes**
- Resolved issues with rendering dimensions for specific types of box
art, improving visual consistency.

- **Documentation**
- Updated README to clarify the boxart requirements and provide multiple
download links for different regions.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Robin Jones <networkfusion@users.noreply.github.com>
2024-08-06 13:20:41 +01:00

4.2 KiB
Raw Blame History

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).
  • Menu sound effects.

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, place PNG files in the /menu/boxart folder on the SD card with the following dimensions:

  • Standard covers: 158x112
  • 64DD covers: 129x112
  • Japanese covers: 112x158

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. You can download these boxart packs:

American Boxart

European Boxart

64DD Boxart

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

Sounds

See License for the following sounds: