From f10097de70c381a218a41e64cb3a88ab2b3f8aa0 Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Sun, 4 Aug 2024 17:56:54 +0100 Subject: [PATCH] Improve documentation (#128) ## Description Split documentation into chunks that users can understand. Improve them to be more idiot proof! ## Motivation and Context Allows an easier way to point people towards specific documentation. #127 #76 ## How Has This Been Tested? ## Screenshots ## Types of changes - [ ] Improvement (non-breaking change that adds a new feature) - [ ] Bug fix (fixes an issue) - [ ] Breaking change (breaking change) - [x] Documentation Improvement - [ ] Config and build (change in the configuration and build system, has no impact on code or features) ## Checklist: - [ ] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. Signed-off-by: GITHUB_USER --- .gitignore | 3 +- Doxyfile | 2 +- README.md | 116 ++++++---------------------------- docs/00_getting_started_sd.md | 82 ++++++++++++++++++++++++ docs/01_menu_controls.md | 14 ++++ docs/99_developer_guide.md | 63 ++++++++++++++++++ 6 files changed, 183 insertions(+), 97 deletions(-) create mode 100644 docs/00_getting_started_sd.md create mode 100644 docs/01_menu_controls.md create mode 100644 docs/99_developer_guide.md diff --git a/.gitignore b/.gitignore index bc2d5ddf..9b9f4205 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ # Ignore generated files in the libdragon FS /filesystem/FiraMonoBold.font64 +/filesystem/*.wav64 # Ignore external development tools /tools/* @@ -14,4 +15,4 @@ # Ignore any N64 ROM **/*.n64 **/*.v64 -**/*.z64 +**/*.z64 \ No newline at end of file diff --git a/Doxyfile b/Doxyfile index 7b99e3b5..4216e624 100644 --- a/Doxyfile +++ b/Doxyfile @@ -905,7 +905,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = README.md ./src +INPUT = README.md ./src ./docs # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/README.md b/README.md index 22de20de..52d5ea2c 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,12 @@ An open source menu for N64 flashcarts. * Music playback (MP3). -### Video showcase (as of Oct 12 2023) +## Documentation +* [Getting started guide](./docs/00_getting_started_sd.md) +* [Menu controls](./docs/01_menu_controls.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)") @@ -40,20 +45,8 @@ An open source menu for N64 flashcarts. * Support as many common mods and features as possible. -## Getting started -Using your PC, insert the SD card and ensure it is formatted for compatibility (We recommend FAT32 in most instances, though EXFAT is fully supported on the SummerCart64). - -### Save files -By default, all save files (whether `FlashRam`, `SRAM` or `EEPROM`) use the `.sav` extension and match the filename of the ROM. - -Each save file can be found in the `/saves` folder located in the same directory as the ROM and shares the same file name, apart from the extension. - -If transfering a file from a different flashcart such as the ED64, it will be necessary to change the extension of the file to `sav`. - -i.e. for `Glover (USA).eep` you would need to change the extension to `Glover (USA).sav` - -**NOTE:** certain emulator saves or saves created for a different ROM version or region may be incompatible. - +## Experimental features +These features are subject to change: ### ROM Boxart To use boxart, you need to place png files of size 158x112 in the folder `/menu/boxart` on the SD card. @@ -63,99 +56,32 @@ i.e. for GoldenEye 3 letters, this would be `NGE.png`. A known set of PNG files using 2 letter ID's can be downloaded [here](https://mega.nz/file/6cNGwSqI#8X5ukb65n3YMlGaUtSOGXkKo9HxVnnMOgqn94Epcr7w). -### Emulator support -Emulators should be added to the `/menu/emulators` directory on the SD card. - -Menu 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) - ### Menu Settings The Menu creates a `config.ini` file in `sd:/menu/` which contains various settings that are used by the menu. -Currently these are read-only (can be viewed in the menu by pressing `L` on the Joypad). If required, you can manually adjust the file on the SD card using your computer. -### SC64 Specific -- Ensure the cart has the latest [firmware](https://github.com/Polprzewodnikowy/SummerCart64/releases/latest) installed. -- Download the latest `sc64menu.n64` file from the releases page, then put it in the root directory of your SD card. -##### 64DD disk support -For the ability to load and run 64DD disk images, you need to place 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). +## Flashcart specific -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 `R` button. +### SC64 +* Ensure the cart has the latest [firmware](https://github.com/Polprzewodnikowy/SummerCart64/releases/latest) installed. +* Download the latest `sc64menu.n64` file from the releases page, then put it in the root directory of your SD card. -### 64drive Specific -- Ensure the cart has the latest [firmware](https://64drive.retroactive.be/support.php) installed. -- Download the latest `menu.bin` file from the releases page, then put it in the root directory of your SD card. +### 64drive +* Ensure the cart has the latest [firmware](https://64drive.retroactive.be/support.php) installed. +* Download the latest `menu.bin` file from the releases page, then put it in the root directory of your SD card. -### ED64 & ED64P Specific +### ED64 & ED64P Currently not supported, but work is in progress (See [PR's](https://github.com/Polprzewodnikowy/N64FlashcartMenu/pulls)). The aim is to replace [Altra64](https://github.com/networkfusion/altra64) and [ED64-UnofficialOS](https://github.com/n64-tools/ED64-UnofficialOS-binaries). -# Developer documentation - -You can use a dev container in VSCode to ease development. - - -## To deploy: -### SC64 -* Download the deployer [here](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.18.0/sc64-deployer-windows-v2.18.0.zip) -* Extract and place `sc64deployer.exe` in the `tools/sc64` directory. - -Make sure that your firmware is compatible (currently v2.18.0+) -See: [here](https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.18.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 - -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`. - -### Ares Emulator -For ease of development and debugging, the menu ROM is able to run in the Ares emulator (without most flashcart features). - -* Ensure you have the Ares emulator on you computer. -* Load the `N64FlashcartMenu.n64` ROM. - -### Others -* Add the required file to the correct folder on your SD card. - - -# Update Libdragon submodule -This repo currently uses the `preview` 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 and auto published to the `gh-pages` branch when merged with `main`. - -Once merged, they can be viewed [here](https://polprzewodnikowy.github.io/N64FlashcartMenu/) - # Open source software and licenses used - - [libdragon](https://github.com/DragonMinded/libdragon) (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) - - [miniz](https://github.com/richgel999/miniz) (MIT License) +* [libdragon](https://github.com/DragonMinded/libdragon) (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) +* [miniz](https://github.com/richgel999/miniz) (MIT License) diff --git a/docs/00_getting_started_sd.md b/docs/00_getting_started_sd.md new file mode 100644 index 00000000..1231a03c --- /dev/null +++ b/docs/00_getting_started_sd.md @@ -0,0 +1,82 @@ +## First time setup of SD card + +Using your PC, insert the SD card and ensure it is formatted for compatibility with your flashcart (*FAT32 and EXFAT are fully supported on the SC64*). + +- Download the latest `sc64menu.n64` (assuming you are using an *sc64*) file from the 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 ROMs on the SD Card, in any folder (**except for `menu`**). + + +### Emulator support +Emulators should be added to the `/menu/emulators` directory on the SD card. + +Menu 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) + + +### 64DD disk support +For the ability to load and run 64DD disk images, you need to 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). + + +#### So what would the layout of the SD Card look like? +```plaintext +SD:\ +│ +├── sc64menu.n64 +│ +│ +├── menu\ +│ │ +│ │ +│ ├── 64ddipl\ +│ │ ├── NDDE0.n64 +│ │ ├── NDDJ2.n64 +│ │ └── NDXJ0.n64 +│ │ +│ └── emulators +│ ├── neon64bu.rom +│ ├── sodium64.z64 +│ ├── gb.v64 +│ └── gbc.v64 +│ +├── (a rom).z64 +├── (a rom).n64 +├── (some folder with roms)\ + │ └── (some folder with roms)\ + | └── (Some supported ROM files) + │ + ├── (Some supported ROM files) + | + └── (Some folder with 64DD disk images)\ + └── (Some 64DD disk images) +``` + + +## Save Files +All save files (whether `FlashRam`, `SRAM` or `EEPROM`) use the `.sav` extension and match the filename of a ROM. + +Each save file can be found in the `/saves` folder located in the **same directory** as the ROM and shares the same file name, apart from the extension. +These files are created and modified when a "game" saves. + +```plaintext +├── (some folder with roms)\ + ├── a_rom.z64 + ├── b_rom.n64 + └── saves\ + ├── a_rom.sav + └── b_rom.sav +``` + +### Transfering saves from an ED64 +If transferring a file from a different flashcart, such as the ED64, it will be necessary to change the extension of the file to `sav`. + +i.e. for `Glover (USA).eep` you would need to change the extension to `Glover (USA).sav` + +You may also need to pad/trim the files to their original size: +- For EEPROM 4Kbit games, remove the padding. +- For others, use a tool such as Ninjiteu's N64 Save converter. + +**NOTE:** certain emulator saves or saves created for a different ROM version or region may be incompatible. diff --git a/docs/01_menu_controls.md b/docs/01_menu_controls.md new file mode 100644 index 00000000..ac0dce8d --- /dev/null +++ b/docs/01_menu_controls.md @@ -0,0 +1,14 @@ +## Menu Controls + +### Fast scroll +Use the C-Up and C-Down buttons + + +### DD ROMs + +#### Expansion Disks +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 `R` button. + +#### Disk swapping +This feature is not currently available in the menu. + diff --git a/docs/99_developer_guide.md b/docs/99_developer_guide.md new file mode 100644 index 00000000..9e00fc43 --- /dev/null +++ b/docs/99_developer_guide.md @@ -0,0 +1,63 @@ +## Developer documentation + +You can use a dev container in VSCode to ease development. + + +### To deploy: +#### SC64 +* Download the deployer [here](https://github.com/Polprzewodnikowy/SummerCart64/releases/download/v2.18.0/sc64-deployer-windows-v2.18.0.zip) +* Extract and place `sc64deployer.exe` in the `tools/sc64` directory. + +Make sure that your firmware is compatible (currently v2.18.0+) +See: [here](https://github.com/Polprzewodnikowy/SummerCart64/blob/v2.18.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 workaround 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 + +Toggle the N64 power switch to load the ROM. + +`ms-vscode.makefile-tools` will help (installed automatically in dev container). +NOTE: it does not yet work with `F5`: see [this blog post](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`. + +#### Ares Emulator +For ease of development and debugging, the menu ROM can run in the Ares emulator (without most flashcart features). + +* Ensure you have the Ares emulator on your computer. +* Load the `N64FlashcartMenu.n64` ROM. + +#### Others +* Add the required file to the correct folder on your SD card. + + +## Update Libdragon submodule +This repo currently uses the `preview` 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 the `output/docs` folder and auto-published to the `gh-pages` branch when merged with `main`. + +### Test generated docs in dev-container +Install Prerequisites: +`apt-get install ruby-full build-essential zlib1g-dev` +`gem install jekyll bundler` +You can then serve the webpage: +`cd output/docs` +`jekyll serve` + + +Once merged, they can be viewed [here](https://polprzewodnikowy.github.io/N64FlashcartMenu/)