First attempt.

Author: networkfusion

CONTRIBUTING.md

@@ -8,4 +8,5 @@ As such, a GitHub account is recommended, which you can sign up for [here](https
 Additionally this document assumes that you already know how to use GitHub and Git.
 If that's not the case, we recommend learning about it first [here](https://docs.github.com/en/get-started/quickstart/hello-world).
 
-**Help us by creating a PR.**
+**Help us by creating a PR.**
+

Doxyfile

@@ -1002,7 +1002,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = ./docs/images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

README.md

@@ -5,19 +5,24 @@
 [![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/Polprzewodnikowy/N64FlashcartMenu/CONTRIBUTING.md)
 
 # N64 Flashcart Menu
-An open source menu for N64 flashcarts.  
-![N64FlashcartMenu menu information](./docs/images/menu-information.png "N64FlashcartMenu menu information")
+An open source menu for N64 flashcarts and aims to support as many as possible. The menu is not affiliated with any partuclar flashcart and does not necessarily expose all capable firmware features.  
+**This project considers flashcart sellers that include this menu or copyrighted ROM's as part of their product offering as licence offenders which may result in future action.**  
 
-## Supported Flashcarts
-This menu aims to support as many N64 flashcarts as possible.
+## Flashcart Supported
+This menu aims to support as many N64 flashcarts as possible. The current state is:
 
-### Fully supported
+### Supported
 * SummerCart64
 * 64Drive
 
-### Work in Progress
-* ED64
-* ED64P
+### Work in Progress (pre-release only)
+* ED64 (X and V series)
+* ED64P (clones)
+
+### Not planned
+* Doctor V64
+* PicoCart
+* DaisyDrive
 
 
 ## Current (notable) menu features
@@ -34,79 +39,20 @@ This menu aims to support as many N64 flashcarts as possible.
 * Menu sound effects.
 * N64 ROM autoload.
 * ROM information descriptions.
-* ROM history and favorites.
+* ROM history and favorites (pre-release only).
 
 
 ## Documentation
-* [Getting started guide](./docs/00_getting_started_sd.md)
-* [Menu controls](./docs/01_menu_controls.md)
-* [Menu customization](./docs/07_menu_customization.md)
-* [Developer guide](./docs/99_developer_guide.md)
-
-## Video showcase (as of Oct 12 2023)
-[![N64FlashcartMenu Showcase](http://img.youtube.com/vi/6CKImHTifDA/0.jpg)](http://www.youtube.com/watch?v=6CKImHTifDA "N64FlashcartMenu Showcase (Oct 12 2023)")
+Please take a moment to browse the current documentation:  
+[Index](./docs/00_index.md)
 
 
 ## Aims
-* Support as many N64 FlashCarts as possible.
+* Support as many N64 Flashcarts as possible.
 * Be open source, using permissively licensed third-party libraries.
 * Be testable in an emulated environment (Ares).
 * Encourage active development from community members and N64 FlashCart owners.
-* Support as many common mods and features as possible.
-
-
-## Experimental features
-These features are subject to change:
-
-### ROM Info descriptions
-To add a ROM description (shown when loading a ROM), add a file with the content
-```
-[metadata]
-description=This is the ROM description that does X Y Z.
-```
-The file line endings must use the linux `LF` endings only (CRLF is not supported) and is limited to 300 characters.
-
-### N64 ROM autoload
-To use the autoload function, while on the `N64 ROM information` display, press the `R` button on your joypad and select the `Set ROM to autoload` option. When you restart the console, it will now only load the selected ROM rather than the menu.  
-**NOTE:** To return to the menu, hold the joypad `Start` button while powering on the console.
-
-### GamePak sprites
-To use N64 GamePak sprites, place PNG files within the `sd:/menu/boxart/` folder.
-
-#### Supported sprites
-These must be `PNG` files that use the following dimensions:
-* Standard N64 GamePak boxart sprites: 158x112
-* Japanese N64 GamePak boxart sprites: 112x158
-* 64DD boxart sprites: 129x112
-
-They will be loaded by directories using each character (case-sensitive) of the full 4 character Game Code (as identified in the menu ROM information).
-i.e. for GoldenEye NTSC USA (NGEE), this would be `sd:/menu/boxart/N/G/E/E/boxart_front.png`.
-i.e. for GoldenEye PAL (NGEP), this would be `sd:/menu/boxart/N/G/E/P/boxart_front.png`.
-
-To improve compatibility between regions (as a fallback), you may exclude the region ID (last matched directory) for GamePaks to match with 3 letter IDs instead:  
-i.e. for GoldenEye, this would be `sd:/menu/boxart/N/G/E/boxart_front.png`.
-
-**Warning**: Excluding the region ID may show the wrong boxart.
-**Note**: For future support, boxart sprites should also include:
-* `boxart_back.png`
-* `boxart_top.png`
-* `boxart_bottom.png`
-* `boxart_left.png`
-* `boxart_right.png`
-* `gamepak_front.png`
-* `gamepak_back.png`
-
-As a starting point, here is a link to a boxart pack, that has `boxart_front.png`:
-* [boxart](https://drive.google.com/file/d/1IpCmFqmGgGwKKmlRBxYObfFR9XywaC6n/view?usp=drive_link)
-
-
-### Menu Settings
-The Menu creates a `config.ini` file in `sd:/menu/` which contains various settings that are used and can be set within the menu.
-If required, you can manually adjust the file on the SD card using your computer.
-
-### Datel cheats
-(Action Replay and GameShark codes)
-Supported, but no GUI available (yet) to edit them.
+* Support as many common mods and features as possible (flashcart dependent).
 
 
 ## Flashcart specific
@@ -115,7 +61,7 @@ Supported, but no GUI available (yet) to edit them.
 * Ensure the cart has the latest [firmware](https://github.com/Polprzewodnikowy/SummerCart64/releases/latest) installed.
 * Download the latest `sc64menu.n64` file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
 
-![SC64 flashcart information](./docs/images/sc64-flashcart-information.png "SC64 flashcart information")
+![SC64 flashcart information](./docs/images/sc64-flashcart-information.png "example SC64 flashcart information")
 
 
 ### 64drive
@@ -141,8 +87,8 @@ The aim is to reach feature parity with [Altra64](https://github.com/networkfusi
 
 
 # Open source software and licenses used
-
-* [libdragon](https://github.com/DragonMinded/libdragon) (UNLICENSE License)
+## libraries
+* [libdragon](https://github.com/DragonMinded/libdragon/tree/preview) (UNLICENSE License)
 * [libspng](https://github.com/randy408/libspng) (BSD 2-Clause License)
 * [mini.c](https://github.com/univrsal/mini.c) (BSD 2-Clause License)
 * [minimp3](https://github.com/lieff/minimp3) (CC0 1.0 Universal)

docs/00_index.md

@@ -0,0 +1,35 @@
+[..](README.md)
+## User Guide
+
+### General
+- [Getting started](./10_getting_started_sd.md)
+- [Menu controls](./11_menu_controls.md)
+- [ROM configuration](./12_rom_configuration.md)
+- [Datel Cheats](./13_datel_cheats.md)
+- [ROM patches](./14_rom_patches.md)
+- [Controller PAKs](./15_controller_paks.md)
+- [Background Images](./16_background_images.md)
+- [64DD](./17_64dd.md)
+- [Emulators](./18_emulators.md)
+- [Boxart](./19_gamepak_boxart.md)
+- [Autoload N64 ROMs](./22_autoload_roms.md)
+
+### Menus
+- [File Browser](./31_file_browser.md)
+- [Menu Settings](./32_menu_settings.md)
+- [RTC Settings](./33_rtc_settings.md)
+- [Menu Information](./35_menu_information.md)
+- [Flashcart Information](./36_flashcart_information.md)
+- [N64 Information](./37_n64_information.md)
+
+### Other
+- [MP3 player](./41_mp3_player.md)
+- [Advanced customization](./61_advanced_customization.md)
+- [Hardware mods](./62_hardware_mods.md)
+#### Experimental Features
+Subject to change  
+- [Experimental Features](./65_experimental.md)
+
+### Developers
+- [Developer guide](./99_developer_guide.md)
+- [Contributing](https://github.com/Polprzewodnikowy/N64FlashcartMenu/blob/main/CONTRIBUTING.md)

docs/07_menu_customization.md

@@ -1,10 +1,11 @@
+[..](./00_index.md)
 ## Initial Setup of SD Card
 
 ### First Steps
 Connect the SD card to your PC and ensure it is properly formatted to be compatible with your flashcart.  
 **WARNING:** Filenames are expected to be written in ASCII, with Western Europe characters fully compatible. Other Unicode characters, such as those from Eastern Europe, Russia, Asia or Middle East regions (to name just a few examples) are not fully supported and may not be displayed.
 
-**Note:** It is advised to use ROM's in the Big Endian format. Although the menu auto converts them, the load time will be increased.  
+**Note:** It is advised to use ROM's in the Big Endian (default) format. Although the menu auto converts byteswapped ROM's, the load time will be increased.  
 
 **Note:** On macOS, if you have extracted ROM's from zips run `dot_clean -m /Volumes/SummerCart` to clear those awful dotfiles so they are not shown in the menu.  
 
@@ -13,32 +14,21 @@ Connect the SD card to your PC and ensure it is properly formatted to be compati
 - An SD formatted with 128 kiB cluster size is recommended.
 
 - Download the latest `sc64menu.n64` file from the [releases](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) page, then put it in the root directory of your SD card.
-- Create a folder in the root of your SD card called `menu`.
 - Place your ROM files on the SD card, **in any folder except `menu`**.  
-**NOTE:** byteswapped ROM's will increase load times.
 
 
 #### Preparations for other supported flashcarts
 - FAT32 recommended.
 - An SD formatted with the default cluster size is recommended.
-
-(TBW)
+- Download the latest [menu](https://github.com/Polprzewodnikowy/N64FlashcartMenu/releases/) file specific for your flashcart and place it in the expected location.
 
 
 ### Emulator Support
-Emulators should be added to the `/menu/emulators` directory on the SD card.
-
-N64FlashcartMenu currently supports the following emulators and associated ROM file names:
-- **NES**: [neon64v2](https://github.com/hcs64/neon64v2/releases) by *hcs64* - `neon64bu.rom`
-- **SNES**: [sodium64](https://github.com/Hydr8gon/sodium64/releases) by *Hydr8gon* - `sodium64.z64`
-- **Game Boy**/**GB Color**: [gb64](https://lambertjamesd.github.io/gb64/romwrapper/romwrapper.html) by *lambertjamesd* - `gb.v64`/`gbc.v64` ("Download Emulator" button)
-- **SMS**/**GG**: [smsPlus64](https://github.com/fhoedemakers/smsplus64/releases) by *fhoedmakers* - `smsPlus64.z64`
-- **Fairchild Channel F**: [Press-F-Ultra](https://github.com/celerizer/Press-F-Ultra/releases) by *celerizer* - `Press-F.z64`
+see [here](./18_emulators.md)
 
 
 ### 64DD Disk Support
-To load and run 64DD disk images, place the required 64DD IPL dumps in the `/menu/64ddipl` folder on the SD card.
-For more details, follow [this guide on the 64dd.org website](https://64dd.org/tutorial_sc64.html).
+See [here](./17_64dd.md)
 
 
 #### So what would the layout of the SD card look like?

docs/00_getting_started_sd.md docs/10_getting_started_sd.mddocs/00_getting_started_sd.md renamed to docs/10_getting_started_sd.md

@@ -1,3 +1,4 @@
+[..](./00_index.md)
 ## Menu Controls
 
 ### Additional Control Information
@@ -7,7 +8,7 @@ Press either the `C-Up` or `C-Down` buttons to scroll by pages, rather than by e
 
 #### N64FlashcartMenu settings
 Press the `START` button on the browser screen to open the Settings window.  
-![Browser context menu](https://github.com/Polprzewodnikowy/N64FlashcartMenu/blob/main/docs/images/main-context-menu.png)  
+![Browser context menu](./images/main-context-menu.png "Browser context menu")  
 From here you can edit some of the N64FlashcartMenu settings, 
 see information about either the console, the flashcart you are using or N64FlashcartMenu itself, and if your cart has Real-Time Clock (RTC) support, you can also change its date and time.
 

docs/01_menu_controls.md docs/11_menu_controls.mddocs/01_menu_controls.md renamed to docs/11_menu_controls.md

@@ -0,0 +1,18 @@
+[..](./00_index.md)
+## ROM configuration
+
+The menu allows overriding the ROM's default configuration that is provided from the internal database.
+
+The internal database is contained within `rom_info.c`
+
+If you override the defaults and want to go back to the default ones, delete the `<rom name>.ini` file.
+
+### Overrideable types
+
+#### CIC type
+
+#### Save type
+
+#### TV Region type
+
+### Autoload

docs/12_rom_configuration.md

@@ -0,0 +1,14 @@
+[..](./00_index.md)
+## Datel Cheats
+AKA InterAct (in certain regions)
+
+The N64 supports the peripherals
+- GameShark
+- Action Replay
+
+It is not advised to connect the physical peripheral with most flashcarts.
+
+The menu has underlying support for these codes (when using an expansion pak), but is not yet exposed via the menu graphical user interface.
+
+Check [Pull Requests](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls) for work towards it.
+

docs/13_datel_cheats.md

@@ -0,0 +1,7 @@
+[..](./00_index.md)
+## ROM patches
+
+Not yet supported, although you can use various online utilities.
+
+Check [Pull Requests](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls) for work towards it.
+The aim is to support APS/IPS/BPS/XDELTA patches.