The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2024-11-22 10:39:20 +01:00
Code Issues Packages Projects Releases Wiki Activity
b3dac541b4
N64FlashcartMenu/index.html
Polprzewodnikowy b3dac541b4 deploy: 91f2e02d34
2024-05-21 16:02:34 +00:00

223 lines
13 KiB
HTML
Raw Blame History

<!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: N64FlashcartMenu</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&amp;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&amp;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">N64FlashcartMenu </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md_README"></a> <img src="https://github.com/polprzewodnikowy/N64FlashcartMenu/actions/workflows/build.yml/badge.svg" alt="Build" style="pointer-events: none;" class="inline"/></p>
<h1><a class="anchor" id="autotoc_md0"></a>
N64 Flashcart Menu</h1>
<p >An open source menu for N64 flashcarts.</p>
<h2><a class="anchor" id="autotoc_md1"></a>
Supported Flashcarts</h2>
<h3><a class="anchor" id="autotoc_md2"></a>
Fully supported</h3>
<ul>
<li>SummerCart64</li>
<li>64Drive</li>
</ul>
<h3><a class="anchor" id="autotoc_md3"></a>
Work in Progress</h3>
<ul>
<li>ED64</li>
<li>ED64P</li>
</ul>
<h2><a class="anchor" id="autotoc_md4"></a>
Current (notable) menu features</h2>
<ul>
<li>Fully Open Source.</li>
<li>Loads all known N64 games (including iQue and Aleck64 ROMs (even if they are byteswapped)).</li>
<li>Fully emulates the 64DD and loads 64DD disks (SummerCart64 only).</li>
<li>Emulator support (NES, SNES, GB, GBC) ROMs.</li>
<li>N64 ROM box image support.</li>
<li>Background image (PNG) support.</li>
<li>Comprehensive ROM save database (including HomeBrew headers).</li>
<li>Comprehensive ROM information display.</li>
<li>Real Time Clock support.</li>
<li>Music playback (MP3).</li>
</ul>
<h3><a class="anchor" id="autotoc_md5"></a>
Video showcase (as of Oct 12 2023)</h3>
<p ><a href="http://www.youtube.com/watch?v=6CKImHTifDA" title="N64FlashcartMenu Showcase (Oct 12 2023)"><img src="http://img.youtube.com/vi/6CKImHTifDA/0.jpg" alt="N64FlashcartMenu Showcase" class="inline"/></a></p>
<h2><a class="anchor" id="autotoc_md6"></a>
Aims</h2>
<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>
<h2><a class="anchor" id="autotoc_md7"></a>
Getting started</h2>
<p >Using your PC, insert the SD card and ensure it is formatted for compatibility (We recommend FAT32 in most instances).</p>
<h3><a class="anchor" id="autotoc_md8"></a>
Save files</h3>
<p >By default, all save files (whether <code>FlashRam</code>, <code>SRAM</code> or <code>EEPROM</code>) use the <code>.sav</code> extension and match the filename of the ROM.</p>
<p >Each save file can be found in the <code>/saves</code> folder located in the same directory as the ROM and shares the same file name, apart from the extension.</p>
<p >If transfering a file from a different flashcart such as the ED64, it will be necessary to change the extension of the file to <code>sav</code>.</p>
<p >i.e. for <code>Glover (USA).eep</code> you would need to change the extension to <code>Glover (USA).sav</code></p>
<p ><b>NOTE:</b> certain emulator saves or saves created for a different ROM version or region may be incompatible.</p>
<h3><a class="anchor" id="autotoc_md9"></a>
ROM Boxart</h3>
<p >To use boxart, you need to place png files of size 158x112 in the folder <code>/menu/boxart</code> on the SD card. Each file must be named according to the 2 letter ROM ID, or 3 letter ROM ID including media type. i.e. for GoldenEye 2 letters, this would be <code>GE.png</code>. i.e. for GoldenEye 3 letters, this would be <code>NGE.png</code>. A known set of PNG files using 2 letter ID's can be downloaded <a href="https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w">here</a>.</p>
<h3><a class="anchor" id="autotoc_md10"></a>
Emulator support</h3>
<p >Emulators should be added to the <code>/menu/emulators</code> directory on the SD card.</p>
<p >Menu currently supports the following emulators and associated ROM file names:</p><ul>
<li><b>NES</b>: <a href="https://github.com/hcs64/neon64v2">neon64v2</a> by <em>hcs64</em> - <code>neon64bu.rom</code></li>
<li><b>SNES</b>: <a href="https://github.com/Hydr8gon/sodium64">sodium64</a> by <em>Hydr8gon</em> - <code>sodium64.z64</code></li>
<li><b>Game Boy</b> / <b>GB Color</b>: <a href="https://lambertjamesd.github.io/gb64/romwrapper/romwrapper.html">gb64</a> by <em>lambertjamesd</em> - <code>gb.v64</code> / <code>gbc.v64</code></li>
<li><b>Sega Master System</b> / <b>Sega Game Gear</b> / <b>Sg1000</b>: <a href="https://github.com/ITotalJustice/TotalSMS">TotalSMS</a> - <code>TotalSMS.z64</code> (Currently broken)</li>
</ul>
<h3><a class="anchor" id="autotoc_md11"></a>
Menu Settings</h3>
<p >The Menu creates a <code>config.ini</code> file in <code>sd:/menu/</code> which contains various settings that are used by the menu. Currently these are read-only (can be viewed in the menu by pressing <code>L</code> on the Joypad). If required, you can manually adjust the file on the SD card using your computer.</p>
<h3><a class="anchor" id="autotoc_md12"></a>
SC64 Specific</h3>
<ul>
<li>Ensure the cart has the latest <a href="https://github.com/Polprzewodnikowy/SummerCart64/releases/latest">firmware</a> installed.</li>
<li>Download the latest <code>sc64menu.n64</code> file from the releases page, then put it in the root directory of your SD card.</li>
</ul>
<p ><a class="anchor" id="autotoc_md13"></a> </p><h5>64DD disk support</h5>
<p >For the ability to load and run 64DD disk images, you need to place required 64DD IPL dumps in the <code>/menu/64ddipl</code> folder on the SD card. For more details follow <a href="https://64dd.org/tutorial_sc64.html">this guide on the 64dd.org website</a>.</p>
<p >Note: to load an expansion disk (e.g. F-Zero X) browse to the N64 ROM and load it (but not start it) and then browse to the DD expansion file and press the <code>R</code> button.</p>
<h3><a class="anchor" id="autotoc_md14"></a>
64drive Specific</h3>
<ul>
<li>Ensure the cart has the latest <a href="https://64drive.retroactive.be/support.php">firmware</a> installed.</li>
<li>Download the latest <code>menu.bin</code> file from the releases page, then put it in the root directory of your SD card.</li>
</ul>
<h3><a class="anchor" id="autotoc_md15"></a>
ED64 &amp; ED64P Specific</h3>
<p >Currently not supported, but work is in progress (See <a href="https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls">PR's</a>).</p>
<p >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>
<h1><a class="anchor" id="autotoc_md16"></a>
Developer documentation</h1>
<p >You can use a dev container in VSCode to ease development.</p>
<h2><a class="anchor" id="autotoc_md17"></a>
To deploy:</h2>
<h3><a class="anchor" id="autotoc_md18"></a>
SC64</h3>
<ul>
<li>Download the deployer <a href="https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.18.0/sc64-deployer-windows-v2.18.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.18.0+) See: <a href="https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.18.0/docs/00_quick_startup_guide.md#firmware-backupupdate">here</a></p>
<h4><a class="anchor" id="autotoc_md19"></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_md20"></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>
<h3><a class="anchor" id="autotoc_md21"></a>
Ares Emulator</h3>
<p >For ease of development and debugging, the menu ROM is able to run in the Ares emulator (without most flashcart features).</p>
<ul>
<li>Ensure you have the Ares emulator on you computer.</li>
<li>Load the <code>N64FlashcartMenu.n64</code> ROM.</li>
</ul>
<h3><a class="anchor" id="autotoc_md22"></a>
Others</h3>
<ul>
<li>Add the required file to the correct folder on your SD card.</li>
</ul>
<h1><a class="anchor" id="autotoc_md23"></a>
Update Libdragon submodule</h1>
<p >This repo currently uses the <code>preview</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_md24"></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 and auto published to the <code>gh-pages</code> branch when merged with <code>main</code>.</p>
<p >Once merged, they can be viewed <a href="https://polprzewodnikowy.github.io/N64FlashcartMenu/">here</a></p>
<h1><a class="anchor" id="autotoc_md25"></a>
Open source software and licenses used</h1>
<ul>
<li><a href="https://github.com/DragonMinded/libdragon">libdragon</a> (UNLICENSE License)</li>
<li><a href="https://github.com/randy408/libspng">libspng</a> (BSD 2-Clause License)</li>
<li><a href="https://github.com/univrsal/mini.c">mini.c</a> (BSD 2-Clause License)</li>
<li><a href="https://github.com/lieff/minimp3">minimp3</a> (CC0 1.0 Universal)</li>
<li><a href="https://github.com/richgel999/miniz">miniz</a> (MIT License) </li>
</ul>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 21 2024 16:02:32 for N64FlashcartMenu by&#160;<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>
Reference in New Issue View Git Blame Copy Permalink