<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=11"/> <meta name="generator" content="Doxygen 1.9.5"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>N64FlashcartMenu: N64 Flashcart Menu</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr id="projectrow"> <td id="projectalign"> <div id="projectname">N64FlashcartMenu </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.9.5 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ var searchBox = new SearchBox("searchBox", "search/",'.html'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */ </script> <div id="main-nav"></div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <div id="MSearchResults"> <div class="SRPage"> <div id="SRIndex"> <div id="SRResults"></div> <div class="SRStatus" id="Loading">Loading...</div> <div class="SRStatus" id="Searching">Searching...</div> <div class="SRStatus" id="NoMatches">No Matches</div> </div> </div> </div> </div> <div><div class="header"> <div class="headertitle"><div class="title">N64 Flashcart Menu </div></div> </div><!--header--> <div class="contents"> <div class="textblock"><p ><a class="anchor" id="md_README"></a><b>This repo and its documentation is currently experimental and subject to change without notice.</b></p> <h1><a class="anchor" id="autotoc_md1"></a> Aims</h1> <ul> <li>Support as many N64 FlashCarts as possible.</li> <li>Be open source, using permissive licensed third party licensed libraries.</li> <li>Be testable, using unit and smoke tests in ares emulated environment.</li> <li>Encourage active development from community members and N64 FlashCart owners.</li> <li>Support as many common mods and features as possible.</li> </ul> <h1><a class="anchor" id="autotoc_md2"></a> Getting started</h1> <h2><a class="anchor" id="autotoc_md3"></a> SC64</h2> <p >Download the <code>sc64menu.n64</code> ROM from the latest action run assets. Add it to the root folder on your SD card.</p> <h2><a class="anchor" id="autotoc_md4"></a> ED64</h2> <p >Currently not supported, but there is an aim to do so. The aim is to replace <a href="https://github.com/networkfusion/altra64">Altra64</a> and <a href="https://github.com/n64-tools/ED64-UnofficialOS-binaries">ED64-UnofficialOS</a>.</p> <h2><a class="anchor" id="autotoc_md5"></a> Common to all</h2> <h3><a class="anchor" id="autotoc_md6"></a> ROM Boxart</h3> <p >To use boxart, you need to place png files of size 158x112 in the folder <code>sd://menu/boxart/</code> Each file must be named according to the 2 letter ROM ID. e.g. for goldeneye, this would be <code>GE.png</code> A known set of PNG files can be downloaded from <a href="https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w">https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w</a></p> <h1><a class="anchor" id="autotoc_md7"></a> Developer documentation</h1> <p ><b>Work in progress!</b></p> <p >You can use a dev container in VSCode to ease development.</p> <h2><a class="anchor" id="autotoc_md8"></a> To deploy:</h2> <h3><a class="anchor" id="autotoc_md9"></a> SC64</h3> <ul> <li>Download the deployer <a href="https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.16.0/sc64-deployer-windows-v2.16.0.zip">here</a></li> <li>Extract and place <code>sc64deployer.exe</code> in the <code>tools/sc64</code> directory.</li> </ul> <p >Make sure that your firmware is compatible (currently v2.16.0+) See: <a href="https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.16.0/docs/00_quick_startup_guide.md#firmware-backupupdate">https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.16.0/docs/00_quick_startup_guide.md#firmware-backupupdate</a></p> <h4><a class="anchor" id="autotoc_md10"></a> From the devcontainer</h4> <p >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, <code>cd ./tools/sc64</code> and then <code>./sc64deployer.exe server</code></p> <p >Then in the dev container, use <code>make run</code> or <code>make run-debug</code></p> <h4><a class="anchor" id="autotoc_md11"></a> From your host (Windows) OS</h4> <ul> <li>Run <code>./localdeploy.bat</code> from the terminal</li> </ul> <p >Toggle the N64 power switch to load the ROM.</p> <p ><code>ms-vscode.makefile-tools</code> will help (installed automatically in dev container). TODO: it does not yet work with <code>F5</code>: see <a href="https://devblogs.microsoft.com/cppblog/now-announcing-makefile-support-in-visual-studio-code/">https://devblogs.microsoft.com/cppblog/now-announcing-makefile-support-in-visual-studio-code/</a> WORKAROUND: in the dev container terminal, use make directly, i.e.: <code>make</code> The ROM can be found in the <code>output</code> directory.</p> <p >NOTE: a "release" version of the SC64 menu is called <code>sc64menu.n64</code> and can be created for when you want to add it directly to the SDCard. This is generated by running <code>make all</code> or running <code>make sc64</code>.</p> <h1><a class="anchor" id="autotoc_md12"></a> Update Libdragon submodule</h1> <p >This repo currently uses the <code>unstable</code> branch as a submodule at a specific commit. To update to the latest version, use <code>git submodule update --remote</code> from the terminal.</p> <h1><a class="anchor" id="autotoc_md13"></a> Generate documentation</h1> <p >Run <code>doxygen</code> from the dev container terminal. Make sure you fix the warnings before creating a PR! Generated documentation is located in <code>output/docs</code> folder.</p> <h1><a class="anchor" id="autotoc_md14"></a> OSS licenses used for libraries</h1> <ul> <li>UNLICENSE (libdragon)</li> <li>BSD 2-Clause (libspng)</li> <li>CC0 1.0 Universal (minimp3)</li> <li>Permissive, unspecific (miniz) </li> </ul> </div></div><!-- PageDoc --> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Aug 4 2023 23:57:26 for N64FlashcartMenu by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </small></address> </body> </html>