From 33b3ff3d1a43637242f90964b91f641e7fd63b09 Mon Sep 17 00:00:00 2001 From: Polprzewodnikowy Date: Thu, 17 Aug 2023 23:21:13 +0000 Subject: [PATCH] deploy: bd7e33ed71bbc991ac8fbf6c928957614ba5ccb2 --- actions_8h.html | 2 +- actions_8h_source.html | 2 +- annotated.html | 2 +- boot_8h.html | 2 +- boot_8h_source.html | 2 +- boot__io_8h.html | 2 +- boot__io_8h_source.html | 2 +- classes.html | 2 +- components_8h.html | 2 +- components_8h_source.html | 2 +- constants_8h.html | 2 +- constants_8h_source.html | 2 +- crc32_8h.html | 2 +- crc32_8h_source.html | 2 +- dir_1a56cc8cdc1689899910be5fa4716ee4.html | 2 +- dir_313caf1132e152dd9b58bea13a4052ca.html | 2 +- dir_4ad298de6e9dc10146d0378a1888b2cb.html | 2 +- dir_52780cb445d9f0b97a98e8aabec4d968.html | 2 +- dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +- dir_a2193b6f8ca8748b0e3b26a8265ce7c7.html | 2 +- dir_abdc04f88b2866c1353f358c089205e4.html | 2 +- dir_c79c44306f0ec79a70cb47ce6bfc5e33.html | 2 +- dir_fc7b276aa2f26a1d485b93ff01d7cabb.html | 2 +- files.html | 2 +- flashcart_8h.html | 2 +- flashcart_8h_source.html | 2 +- flashcart__utils_8h.html | 2 +- flashcart__utils_8h_source.html | 2 +- fonts_8h.html | 2 +- fonts_8h_source.html | 2 +- fs_8h_source.html | 2 +- functions.html | 2 +- functions_vars.html | 2 +- globals.html | 2 +- globals_enum.html | 2 +- globals_eval.html | 2 +- globals_func.html | 2 +- group__sc64.html | 2 +- group__view.html | 2 +- hdmi_8h_source.html | 2 +- index.html | 47 +++++++++++++++-------- menu_8h.html | 2 +- menu_8h_source.html | 2 +- menu__state_8h.html | 2 +- menu__state_8h_source.html | 2 +- modules.html | 2 +- mp3__player_8h_source.html | 2 +- path_8h.html | 2 +- path_8h_source.html | 2 +- png__decoder_8h_source.html | 2 +- rom__database_8h.html | 2 +- rom__database_8h_source.html | 2 +- sc64_8h.html | 2 +- sc64_8h_source.html | 2 +- sc64__ll_8h.html | 2 +- sc64__ll_8h_source.html | 2 +- settings_8h.html | 2 +- settings_8h_source.html | 2 +- structcache__metadata__t.html | 2 +- structcomponent__background__t.html | 2 +- structflashcart__t.html | 2 +- structipl3__crc32__t.html | 2 +- structmp3player__t.html | 2 +- structpng__decoder__t.html | 2 +- structsc64__cmd__t.html | 2 +- structsc64__regs__t.html | 2 +- utils_8h_source.html | 2 +- views_8h.html | 2 +- views_8h_source.html | 2 +- 69 files changed, 98 insertions(+), 85 deletions(-) diff --git a/actions_8h.html b/actions_8h.html index 5b008fae..cada0f64 100644 --- a/actions_8h.html +++ b/actions_8h.html @@ -95,7 +95,7 @@ void actions_update (< diff --git a/actions_8h_source.html b/actions_8h_source.html index a9ed1f01..23dadc53 100644 --- a/actions_8h_source.html +++ b/actions_8h_source.html @@ -93,7 +93,7 @@ $(function() { diff --git a/annotated.html b/annotated.html index 1a8b5411..74ce905a 100644 --- a/annotated.html +++ b/annotated.html @@ -107,7 +107,7 @@ $(function() { diff --git a/boot_8h.html b/boot_8h.html index e22cfbc3..1d139b3e 100644 --- a/boot_8h.html +++ b/boot_8h.html @@ -169,7 +169,7 @@ detect_cic_seed diff --git a/boot_8h_source.html b/boot_8h_source.html index 5535f5d7..ecb6ad3b 100644 --- a/boot_8h_source.html +++ b/boot_8h_source.html @@ -122,7 +122,7 @@ $(function() { diff --git a/boot__io_8h.html b/boot__io_8h.html index babc22fe..3a60f967 100644 --- a/boot__io_8h.html +++ b/boot__io_8h.html @@ -922,7 +922,7 @@ RLS diff --git a/boot__io_8h_source.html b/boot__io_8h_source.html index 49ff77c8..0ff4f539 100644 --- a/boot__io_8h_source.html +++ b/boot__io_8h_source.html @@ -321,7 +321,7 @@ $(function() { diff --git a/classes.html b/classes.html index 737cf214..a9af9f6e 100644 --- a/classes.html +++ b/classes.html @@ -117,7 +117,7 @@ $(function() { diff --git a/components_8h.html b/components_8h.html index 114f7353..77260973 100644 --- a/components_8h.html +++ b/components_8h.html @@ -188,7 +188,7 @@ image diff --git a/components_8h_source.html b/components_8h_source.html index 445c5f13..ae8ae3f4 100644 --- a/components_8h_source.html +++ b/components_8h_source.html @@ -123,7 +123,7 @@ $(function() { diff --git a/constants_8h.html b/constants_8h.html index af45b930..202905a1 100644 --- a/constants_8h.html +++ b/constants_8h.html @@ -239,7 +239,7 @@ Macros diff --git a/constants_8h_source.html b/constants_8h_source.html index 6c68037b..1fdf0314 100644 --- a/constants_8h_source.html +++ b/constants_8h_source.html @@ -157,7 +157,7 @@ $(function() { diff --git a/crc32_8h.html b/crc32_8h.html index 114f63d1..851b616d 100644 --- a/crc32_8h.html +++ b/crc32_8h.html @@ -95,7 +95,7 @@ uint32_t crc32_calculate diff --git a/crc32_8h_source.html b/crc32_8h_source.html index 74fc48c6..4f9bf56b 100644 --- a/crc32_8h_source.html +++ b/crc32_8h_source.html @@ -92,7 +92,7 @@ $(function() { diff --git a/dir_1a56cc8cdc1689899910be5fa4716ee4.html b/dir_1a56cc8cdc1689899910be5fa4716ee4.html index 50f9b6c9..d0258b37 100644 --- a/dir_1a56cc8cdc1689899910be5fa4716ee4.html +++ b/dir_1a56cc8cdc1689899910be5fa4716ee4.html @@ -118,7 +118,7 @@ Files diff --git a/dir_313caf1132e152dd9b58bea13a4052ca.html b/dir_313caf1132e152dd9b58bea13a4052ca.html index 1968aaaa..6e44d880 100644 --- a/dir_313caf1132e152dd9b58bea13a4052ca.html +++ b/dir_313caf1132e152dd9b58bea13a4052ca.html @@ -87,7 +87,7 @@ Files diff --git a/dir_4ad298de6e9dc10146d0378a1888b2cb.html b/dir_4ad298de6e9dc10146d0378a1888b2cb.html index f3dafd29..4b54d37c 100644 --- a/dir_4ad298de6e9dc10146d0378a1888b2cb.html +++ b/dir_4ad298de6e9dc10146d0378a1888b2cb.html @@ -89,7 +89,7 @@ Files diff --git a/dir_52780cb445d9f0b97a98e8aabec4d968.html b/dir_52780cb445d9f0b97a98e8aabec4d968.html index d0d1442e..0b49e804 100644 --- a/dir_52780cb445d9f0b97a98e8aabec4d968.html +++ b/dir_52780cb445d9f0b97a98e8aabec4d968.html @@ -92,7 +92,7 @@ Files diff --git a/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/dir_68267d1309a1af8e8297ef4c3efbcdba.html index cc66c4ea..48f9b580 100644 --- a/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -93,7 +93,7 @@ Directories diff --git a/dir_a2193b6f8ca8748b0e3b26a8265ce7c7.html b/dir_a2193b6f8ca8748b0e3b26a8265ce7c7.html index b160d593..21ffc1e7 100644 --- a/dir_a2193b6f8ca8748b0e3b26a8265ce7c7.html +++ b/dir_a2193b6f8ca8748b0e3b26a8265ce7c7.html @@ -86,7 +86,7 @@ Files diff --git a/dir_abdc04f88b2866c1353f358c089205e4.html b/dir_abdc04f88b2866c1353f358c089205e4.html index 253ce2c9..88ac6d8e 100644 --- a/dir_abdc04f88b2866c1353f358c089205e4.html +++ b/dir_abdc04f88b2866c1353f358c089205e4.html @@ -94,7 +94,7 @@ Files diff --git a/dir_c79c44306f0ec79a70cb47ce6bfc5e33.html b/dir_c79c44306f0ec79a70cb47ce6bfc5e33.html index f70c9be9..9ecff0ee 100644 --- a/dir_c79c44306f0ec79a70cb47ce6bfc5e33.html +++ b/dir_c79c44306f0ec79a70cb47ce6bfc5e33.html @@ -85,7 +85,7 @@ Files diff --git a/dir_fc7b276aa2f26a1d485b93ff01d7cabb.html b/dir_fc7b276aa2f26a1d485b93ff01d7cabb.html index ddb728cb..a5525c57 100644 --- a/dir_fc7b276aa2f26a1d485b93ff01d7cabb.html +++ b/dir_fc7b276aa2f26a1d485b93ff01d7cabb.html @@ -86,7 +86,7 @@ Files diff --git a/files.html b/files.html index daf92298..41f0f17c 100644 --- a/files.html +++ b/files.html @@ -110,7 +110,7 @@ $(function() { diff --git a/flashcart_8h.html b/flashcart_8h.html index 641f1b6f..67252412 100644 --- a/flashcart_8h.html +++ b/flashcart_8h.html @@ -152,7 +152,7 @@ Functions diff --git a/flashcart_8h_source.html b/flashcart_8h_source.html index f49031ab..23064f55 100644 --- a/flashcart_8h_source.html +++ b/flashcart_8h_source.html @@ -133,7 +133,7 @@ $(function() { diff --git a/flashcart__utils_8h.html b/flashcart__utils_8h.html index f9076770..1c03469a 100644 --- a/flashcart__utils_8h.html +++ b/flashcart__utils_8h.html @@ -101,7 +101,7 @@ void pi_dma_write_data diff --git a/flashcart__utils_8h_source.html b/flashcart__utils_8h_source.html index be52c492..d5526126 100644 --- a/flashcart__utils_8h_source.html +++ b/flashcart__utils_8h_source.html @@ -93,7 +93,7 @@ $(function() { diff --git a/fonts_8h.html b/fonts_8h.html index 7f67f59b..2a335e22 100644 --- a/fonts_8h.html +++ b/fonts_8h.html @@ -112,7 +112,7 @@ void fonts_init (void) diff --git a/fonts_8h_source.html b/fonts_8h_source.html index 40423ca9..c98fa224 100644 --- a/fonts_8h_source.html +++ b/fonts_8h_source.html @@ -101,7 +101,7 @@ $(function() { diff --git a/fs_8h_source.html b/fs_8h_source.html index a2e58be2..3437a922 100644 --- a/fs_8h_source.html +++ b/fs_8h_source.html @@ -106,7 +106,7 @@ $(function() { diff --git a/functions.html b/functions.html index 29828a61..e56b8437 100644 --- a/functions.html +++ b/functions.html @@ -87,7 +87,7 @@ $(function() { diff --git a/functions_vars.html b/functions_vars.html index 83d40970..d663b224 100644 --- a/functions_vars.html +++ b/functions_vars.html @@ -87,7 +87,7 @@ $(function() { diff --git a/globals.html b/globals.html index b93f2762..ca706e1f 100644 --- a/globals.html +++ b/globals.html @@ -175,7 +175,7 @@ $(function() { diff --git a/globals_enum.html b/globals_enum.html index fb3b701d..c9338bc3 100644 --- a/globals_enum.html +++ b/globals_enum.html @@ -87,7 +87,7 @@ $(function() { diff --git a/globals_eval.html b/globals_eval.html index 91296867..21b32981 100644 --- a/globals_eval.html +++ b/globals_eval.html @@ -149,7 +149,7 @@ $(function() { diff --git a/globals_func.html b/globals_func.html index 0e38f307..3310409b 100644 --- a/globals_func.html +++ b/globals_func.html @@ -75,7 +75,7 @@ $(function() { diff --git a/group__sc64.html b/group__sc64.html index 95f085de..2ba1f69e 100644 --- a/group__sc64.html +++ b/group__sc64.html @@ -260,7 +260,7 @@ FLASHRAM[128] diff --git a/group__view.html b/group__view.html index 566996fa..55cdb3c1 100644 --- a/group__view.html +++ b/group__view.html @@ -151,7 +151,7 @@ void menu_show_error ( diff --git a/hdmi_8h_source.html b/hdmi_8h_source.html index 51e56b9b..1c93c7e6 100644 --- a/hdmi_8h_source.html +++ b/hdmi_8h_source.html @@ -93,7 +93,7 @@ $(function() { diff --git a/index.html b/index.html index 3a6e1bc3..cf670e24 100644 --- a/index.html +++ b/index.html @@ -72,7 +72,7 @@ $(function() {
N64 Flashcart Menu
-

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

+

An open source menu for N64 flashcarts.

Aims

    @@ -83,43 +83,56 @@ Aims
  • Support as many common mods and features as possible.

+Current (notable) menu features

+
    +
  • Fully Open Source.
  • +
  • Loads all known N64 games (including iQue and byteswapped ROMs).
  • +
  • Emulator support (GB, GBC, NES) 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).
  • +
+

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.

+SC64 +

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

+ED64 & ED64P

+

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:

-

+

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
  • @@ -127,13 +140,13 @@ From your host (Windows) OS

    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)
    • @@ -145,7 +158,7 @@ OSS licenses used for libraries
diff --git a/menu_8h.html b/menu_8h.html index 056680bf..81915a7f 100644 --- a/menu_8h.html +++ b/menu_8h.html @@ -95,7 +95,7 @@ void menu_run (
diff --git a/menu_8h_source.html b/menu_8h_source.html index 3b3a89f5..32f18621 100644 --- a/menu_8h_source.html +++ b/menu_8h_source.html @@ -93,7 +93,7 @@ $(function() {
diff --git a/menu__state_8h.html b/menu__state_8h.html index c4bec9fe..9f9a1f97 100644 --- a/menu__state_8h.html +++ b/menu__state_8h.html @@ -399,7 +399,7 @@ selected diff --git a/menu__state_8h_source.html b/menu__state_8h_source.html index 3cb746d2..e4a6c7b8 100644 --- a/menu__state_8h_source.html +++ b/menu__state_8h_source.html @@ -179,7 +179,7 @@ $(function() { diff --git a/modules.html b/modules.html index 91f1f52d..d6dd6f43 100644 --- a/modules.html +++ b/modules.html @@ -81,7 +81,7 @@ $(function() { diff --git a/mp3__player_8h_source.html b/mp3__player_8h_source.html index 9f5b42d7..bd9ac207 100644 --- a/mp3__player_8h_source.html +++ b/mp3__player_8h_source.html @@ -116,7 +116,7 @@ $(function() { diff --git a/path_8h.html b/path_8h.html index e35bca41..23368a12 100644 --- a/path_8h.html +++ b/path_8h.html @@ -175,7 +175,7 @@ capacity diff --git a/path_8h_source.html b/path_8h_source.html index c22e0935..0cc797b1 100644 --- a/path_8h_source.html +++ b/path_8h_source.html @@ -112,7 +112,7 @@ $(function() { diff --git a/png__decoder_8h_source.html b/png__decoder_8h_source.html index a715017d..70a5db10 100644 --- a/png__decoder_8h_source.html +++ b/png__decoder_8h_source.html @@ -106,7 +106,7 @@ $(function() { diff --git a/rom__database_8h.html b/rom__database_8h.html index 5b3106cf..ca994289 100644 --- a/rom__database_8h.html +++ b/rom__database_8h.html @@ -628,7 +628,7 @@ The ROM file release version. diff --git a/rom__database_8h_source.html b/rom__database_8h_source.html index 7f64f875..9e299bf0 100644 --- a/rom__database_8h_source.html +++ b/rom__database_8h_source.html @@ -282,7 +282,7 @@ $(function() { diff --git a/sc64_8h.html b/sc64_8h.html index 1eec6e2d..e84d48c3 100644 --- a/sc64_8h.html +++ b/sc64_8h.html @@ -95,7 +95,7 @@ Functions diff --git a/sc64_8h_source.html b/sc64_8h_source.html index 1ef40dd7..fe822d3e 100644 --- a/sc64_8h_source.html +++ b/sc64_8h_source.html @@ -93,7 +93,7 @@ $(function() { diff --git a/sc64__ll_8h.html b/sc64__ll_8h.html index 9afb34a5..476df4d0 100644 --- a/sc64__ll_8h.html +++ b/sc64__ll_8h.html @@ -225,7 +225,7 @@ sc64_error_t sc64_ll_flash diff --git a/sc64__ll_8h_source.html b/sc64__ll_8h_source.html index b8131e98..53a223ff 100644 --- a/sc64__ll_8h_source.html +++ b/sc64__ll_8h_source.html @@ -196,7 +196,7 @@ $(function() { diff --git a/settings_8h.html b/settings_8h.html index 81bdf3c2..11cac5a2 100644 --- a/settings_8h.html +++ b/settings_8h.html @@ -142,7 +142,7 @@ Default directory to navigate to when menu loads. diff --git a/settings_8h_source.html b/settings_8h_source.html index 00740913..7f7c1909 100644 --- a/settings_8h_source.html +++ b/settings_8h_source.html @@ -102,7 +102,7 @@ $(function() { diff --git a/structcache__metadata__t.html b/structcache__metadata__t.html index 464957c0..076f505a 100644 --- a/structcache__metadata__t.html +++ b/structcache__metadata__t.html @@ -153,7 +153,7 @@ uint32_t size diff --git a/structcomponent__background__t.html b/structcomponent__background__t.html index cb362d56..e9212486 100644 --- a/structcomponent__background__t.html +++ b/structcomponent__background__t.html @@ -136,7 +136,7 @@ rspq_block_t * image_displ diff --git a/structflashcart__t.html b/structflashcart__t.html index 4f3b8fe2..594d2d7b 100644 --- a/structflashcart__t.html +++ b/structflashcart__t.html @@ -112,7 +112,7 @@ Data Fields diff --git a/structipl3__crc32__t.html b/structipl3__crc32__t.html index 37e22271..80f380c3 100644 --- a/structipl3__crc32__t.html +++ b/structipl3__crc32__t.html @@ -119,7 +119,7 @@ const uint8_t seed diff --git a/structmp3player__t.html b/structmp3player__t.html index 5376c058..7ece9f11 100644 --- a/structmp3player__t.html +++ b/structmp3player__t.html @@ -306,7 +306,7 @@ waveform_t wave diff --git a/structpng__decoder__t.html b/structpng__decoder__t.html index c335ac9d..05d028c3 100644 --- a/structpng__decoder__t.html +++ b/structpng__decoder__t.html @@ -221,7 +221,7 @@ void * callback_data diff --git a/structsc64__cmd__t.html b/structsc64__cmd__t.html index ad9bf847..7ae63c00 100644 --- a/structsc64__cmd__t.html +++ b/structsc64__cmd__t.html @@ -136,7 +136,7 @@ uint32_t rsp [2]< diff --git a/structsc64__regs__t.html b/structsc64__regs__t.html index 205be1a3..f7a48c1b 100644 --- a/structsc64__regs__t.html +++ b/structsc64__regs__t.html @@ -153,7 +153,7 @@ uint32_t KEY diff --git a/utils_8h_source.html b/utils_8h_source.html index ddb44a70..091cc7b5 100644 --- a/utils_8h_source.html +++ b/utils_8h_source.html @@ -93,7 +93,7 @@ $(function() { diff --git a/views_8h.html b/views_8h.html index fbeb88f1..68ef1117 100644 --- a/views_8h.html +++ b/views_8h.html @@ -161,7 +161,7 @@ void menu_show_error ( diff --git a/views_8h_source.html b/views_8h_source.html index fada9f5e..e8d152c3 100644 --- a/views_8h_source.html +++ b/views_8h_source.html @@ -127,7 +127,7 @@ $(function() {