forked from Polprzewodnikowy/N64FlashcartMenu
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve documentation (Polprzewodnikowy#128)
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Split documentation into chunks that users can understand. Improve them to be more idiot proof! ## Motivation and Context <!--- What does this sample do? What problem does it solve? --> <!--- If it fixes/closes/resolves an open issue, please link to the issue here --> Allows an easier way to point people towards specific documentation. Polprzewodnikowy#127 Polprzewodnikowy#76 ## How Has This Been Tested? <!-- (if applicable) --> <!--- Please describe in detail how you tested your sample/changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> ## Screenshots <!-- (if appropriate): --> ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] 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: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [ ] 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. <!--- It would be nice if you could sign off your contribution by replacing the name with your GitHub user name and GitHub email contact. --> Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL>
- Loading branch information
1 parent
8b624f6
commit f10097d
Showing
6 changed files
with
183 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/) |