bc335d8859
<!--- Provide a general summary of your changes in the Title above -->
## Description
<!--- Describe your changes in detail -->
The CI uses the devcontainer to build libdragon, but that has already
occured as part of the devcontainer initialization.
## 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 -->
The CI was taking longer to build than expected.
If/when we move to native CI, we should leverage the CI which would
include:
```
# - name: Cache libDragon build
# id: cache-libdragon
# uses: actions/cache@v3
# env:
# cache-name: cache-libdragon
# with:
# # libdragon cache files are stored in `./libdragon`
# path: ./libdragon
# key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('./.gitmodules') }}
# restore-keys: |
# ${{ runner.os }}-build-${{ env.cache-name }}-
# ${{ runner.os }}-build-
# ${{ runner.os }}-
# - name: Build libDragon
# if: ${{ steps.cache-libdragon.outputs.cache-hit != 'true' }}
# uses: devcontainers/ci@v0.3
# with:
# imageName: ghcr.io/polprzewodnikowy/n64flashcartmenu-devcontainer
# cacheFrom: ghcr.io/polprzewodnikowy/n64flashcartmenu-devcontainer
# push: ${{ github.repository_owner == 'Polprzewodnikowy' && 'filter' || 'never' }}
# refFilterForPush: refs/heads/main
# runCmd: |
# pushd libdragon
# ./build.sh
# popd
```
## 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>
|
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| assets | ||
| libdragon@e37421e8e3 | ||
| src | ||
| tools | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| Doxyfile | ||
| localdeploy.bat | ||
| Makefile | ||
| README.md | ||
| remotedeploy.sh | ||
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
Emulator support
Emulators should be added to the sd:/emulators/ folder
The menu currently supports the following emulators and associated ROM's:
- neon64v2 (https://github.com/hcs64/neon64v2) - emu.nes
- gb64 (https://lambertjamesd.github.io/gb64/romwrapper/romwrapper.html) - emu.gb, emu.gbc
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.exein thetools/sc64directory.
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.batfrom 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.
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!
Generated documentation is located in output/docs folder.
OSS licenses used for libraries
- UNLICENSE (libdragon)
- BSD 2-Clause (libspng)
- CC0 1.0 Universal (minimp3)
- Permissive, unspecific (miniz)