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

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

## 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-07-30 21:30:19 +02:00
.devcontainer Changed config library from toml to mini.c 2023-07-11 18:00:18 +02:00
.github Fix CI (https://github.com/devcontainers/ci/issues/252) 2023-07-28 12:20:49 +02:00
assets Menu improvements (#9) 2023-07-09 00:52:39 +02:00
docs Documentation improvements (#6) 2023-02-22 19:11:49 +01:00
libdragon@1c35500e78 Add N64 ROM boxart capability (#16) 2023-07-26 17:55:23 +02:00
src Fixed SD card fault display + ROM boot changes 2023-07-29 11:52:24 +02:00
tools/sc64 ROM DB additions (#12) 2023-07-16 12:27:56 +02:00
.gitattributes Mark src/libs folder as vendored code 2023-07-26 12:43:18 +02:00
.gitignore Menu improvements (#9) 2023-07-09 00:52:39 +02:00
.gitmodules PNG decoder + reduced number of directory entries + external libs header cleanup 2023-07-25 19:20:29 +02:00
Doxyfile Menu improvements (#9) 2023-07-09 00:52:39 +02:00
localdeploy.bat Improve dev container (#4) 2023-06-04 16:57:31 +01:00
Makefile Added background image and ability to set it from the image viewer 2023-07-28 21:36:51 +02:00
README.md Improve readme (#29) 2023-07-30 21:30:19 +02:00
remotedeploy.sh Improve dev container (#4) 2023-06-04 16:57:31 +01:00

README.md

N64 Flashcart Menu

This repo and its documentation is currently experimental and subject to change without notice.

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.

Getting started

SC64

Download the sc64menu.n64 ROM from the latest action run assets. Add it to the root folder on your SD card.

ED64

Currently not supported, but there is an aim to do so. The aim is to replace Altra64 and ED64-UnofficialOS.

Common to all

ROM Boxart

To use boxart, you need to place png files of size 158x112 in the folder sd://menu/boxart/ 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 from https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w

Developer documentation

Work in progress!

You can use a dev container in VSCode to ease development.

To deploy:

SC64

  • Download the deployer here
  • Extract and place sc64deployer.exe in the tools/sc64 directory.

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

From the devcontainer

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

Then in the dev container, use make run or make run-debug

From your host (Windows) OS

  • Run ./localdeploy.bat from the terminal

Toggle the N64 power switch to load the ROM.

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/ WORKAROUND: in the dev container terminal, use make directly, i.e.: make The ROM can be found in the output directory.

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

Update Libdragon submodule

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.

Generate documentation

Run doxygen from the dev container terminal. Make sure you fix the warnings before creating a PR!

OSS licenses used for libraries

  • UNLICENSE (libdragon)
  • BSD 2-Clause (libspng)
  • CC0 1.0 Universal (minimp3)
  • Permissive, unspecific (miniz)