<divclass="headertitle"><divclass="title">N64 Flashcart Menu </div></div>
</div><!--header-->
<divclass="contents">
<divclass="textblock"><p><aclass="anchor"id="md_README"></a><b>This repo and its documentation is currently experimental and subject to change without notice.</b></p>
<h1><aclass="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><aclass="anchor"id="autotoc_md2"></a>
Getting started</h1>
<h2><aclass="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><aclass="anchor"id="autotoc_md4"></a>
ED64</h2>
<p>Currently not supported, but there is an aim to do so. The aim is to replace <ahref="https://github.com/networkfusion/altra64">Altra64</a> and <ahref="https://github.com/n64-tools/ED64-UnofficialOS-binaries">ED64-UnofficialOS</a>.</p>
<h2><aclass="anchor"id="autotoc_md5"></a>
Common to all</h2>
<h3><aclass="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 <ahref="https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w">https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w</a></p>
<h1><aclass="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><aclass="anchor"id="autotoc_md8"></a>
To deploy:</h2>
<h3><aclass="anchor"id="autotoc_md9"></a>
SC64</h3>
<ul>
<li>Download the deployer <ahref="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: <ahref="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><aclass="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><aclass="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 <ahref="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><aclass="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><aclass="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>
Generated on Fri Aug 4 2023 23:41:42 for N64FlashcartMenu by <ahref="https://www.doxygen.org/index.html"><imgclass="footer"src="doxygen.svg"width="104"height="31"alt="doxygen"/></a> 1.9.5
